Create a source

POST 
/v2/sources/

Creates a single use source that wraps the details of a credit card, wallet or bank account. These sources can only be used once: by creating a new charge object, or attaching them to a customer.

Request

application/json

Body

required

type SourceTyperequired

Possible values: [card, gcash, paymaya, wechat, alipay, unionpay, grabpay, instapay, qrph, bpi, unionbank, metrobank, bdo, pnb, rcbc]

An enumeration.

card

object

name Name (string)required

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

Full name of cardholder

number Card Number (string)required

The 16-digit card number

exp_month Expiry month (string)required

Possible values: non-empty and <= 2 characters

Expiration month of the card.

exp_year Expiry year (string)required

Possible values: >= 4 characters and <= 4 characters

Four-digit number expiration year of the card.

cvc CVC (string)required

Possible values: >= 3 characters and <= 4 characters

The card’s security code.

address_line1 Address Line1 (string)

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

address_line2 Address Line2 (string)

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

address_city Address City (string)

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

address_state Address State (string)

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

address_country Address Country (string)

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

address_zip Address Zip (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

redirect

object

success urirequired

Possible values: non-empty and <= 2083 characters

The URL where we redirect after successful payment.

fail urirequired

Possible values: non-empty and <= 2083 characters

The URL where we redirect after failed payment.

notify uri

Possible values: non-empty and <= 2083 characters

The URL where we will call repeatedly, until a proper response was received.

owner

object

billing

object

name Name (string)required

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

Full name of account holder

phone_number Phone Number (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

email email

line1 Line 1 (string)

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

line2 Line 2 (string)

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

city City (string)

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

state State (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

country Country (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

zip_code Zip Code (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

shipping

object

name Name (string)required

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

Full name of account holder

phone_number Phone Number (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

email email

line1 Line 1 (string)

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

line2 Line 2 (string)

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

city City (string)

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

state State (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

country Country (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

zip_code Zip Code (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

name Name (string)

Possible values: <= 50 characters

Full name of account holder

address_country Country (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

Responses

200

Successful Response

application/json

Schema

Schema

object Object (string)required

String representing the object's type. Objects of the same type share the same value.

id ID (string)required

A unique ID for this source, usually starts with src_, followed by an alphanumeric string.

type SourceTyperequired

Possible values: [card, gcash, paymaya, wechat, alipay, unionpay, grabpay, instapay, qrph, bpi, unionbank, metrobank, bdo, pnb, rcbc]

An enumeration.

card

object

object Object (string)required

String representing the object's type. Objects of the same type share the same value.

id ID (string)required

A unique ID for this card, usually starts with card_, followed by an alphanumeric string.

name Name (string)required

Full name of cardholder

last4 Card Number (string)required

The last 4 digits of the credit card number

exp_month Expiry month (string)required

Expiration month of the card.

exp_year Expiry year (string)required

Four-digit number expiration year of the card.

address_line1 Address Line1 (string)

address_line2 Address Line2 (string)

address_city Address City (string)

address_state Address State (string)

address_country Address Country (string)

address_zip Address Zip (string)

brand Brand (string)required

country Country (string)required

cvc_checked Cvc Checked (string)required

funding Funding (string)required

issuing_bank Issuing Bank (string)required

bank_account

object

reference_id Reference Id (string)required

Reference Id we used in connecting to debit api

bank_type Bank Type (string)required

Token's bank type

bank_code Bank Code (string)required

Specific bank's code

account_name Account name (string)required

account_number Account number (string)required

account_type Account type (string)required

expires_at Expiration date (string)required

metadata object

redirect

object

success urirequired

Possible values: non-empty and <= 2083 characters

The URL where we redirect after successful payment.

fail urirequired

Possible values: non-empty and <= 2083 characters

The URL where we redirect after failed payment.

notify uri

Possible values: non-empty and <= 2083 characters

The URL where we will call repeatedly, until a proper response was received.

owner

object

billing

object

name Name (string)required

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

Full name of account holder

phone_number Phone Number (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

email email

line1 Line 1 (string)

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

line2 Line 2 (string)

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

city City (string)

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

state State (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

country Country (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

zip_code Zip Code (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

shipping

object

name Name (string)required

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

Full name of account holder

phone_number Phone Number (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

email email

line1 Line 1 (string)

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

line2 Line 2 (string)

Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

city City (string)

Possible values: non-empty and <= 100 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

state State (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

country Country (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

zip_code Zip Code (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

name Name (string)

Possible values: <= 50 characters

Full name of account holder

address_country Country (string)

Possible values: non-empty and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\s\'#_\.\-,]+$

vaulted Vaulted (boolean)required

Whether this source has been securely saved for later reuse.

used Used (boolean)required

Whether this source has already been used.

livemode Live Mode (boolean)required

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

created_at Created Date (string)required

Time at which the object was created in ISO 8601 format.

updated_at Updated Date (string)required

Time at which the object was updated in ISO 8601 format.

metadata object

Example (from schema)

{
  "object": "source",
  "id": "src_01786de4d9d69ad1369bfd56b098ccd9",
  "card": {
    "object": "source",
    "id": "card_01786e96b17d197aacd0de4e1f01ac5f",
    "name": "Gerry Isaac",
    "last4": "1112",
    "exp_month": "12",
    "exp_year": "2025",
    "address_line1": "string",
    "address_line2": "string",
    "address_city": "string",
    "address_state": "string",
    "address_country": "string",
    "address_zip": "string",
    "brand": "string",
    "country": "string",
    "cvc_checked": "string",
    "funding": "string",
    "issuing_bank": "string"
  },
  "bank_account": {
    "reference_id": "cus_123123123",
    "bank_type": "BPI",
    "bank_code": "magpiebpi",
    "account_name": "",
    "account_number": "",
    "account_type": "",
    "expires_at": "",
    "metadata": {}
  },
  "redirect": {
    "success": "https://magpie.im/?status=success",
    "fail": "https://magpie.im/?status=failed",
    "notify": "https://magpie.im/?status=notification"
  },
  "owner": {
    "billing": {
      "name": "Gerry Isaac",
      "phone_number": "639175511222",
      "email": "[email protected]",
      "line1": "#123 JP Rizal St.",
      "line2": "Brgy. Aguinaldo",
      "city": "Quezon City",
      "state": "Metro Manila",
      "country": "PH",
      "zip_code": "1100"
    },
    "shipping": {
      "name": "Gerry Isaac",
      "phone_number": "639175511222",
      "email": "[email protected]",
      "line1": "#123 JP Rizal St.",
      "line2": "Brgy. Aguinaldo",
      "city": "Quezon City",
      "state": "Metro Manila",
      "country": "PH",
      "zip_code": "1100"
    },
    "name": "Gerry Isaac",
    "address_country": "PH"
  },
  "vaulted": false,
  "used": false,
  "livemode": true,
  "created_at": "2021-03-26T17:36:57.828847+08:00",
  "updated_at": "2021-03-26T17:36:57.828847+08:00",
  "metadata": {}
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...