List all charges

GET 
/v2/charges/

Retrieves a list of charges

Request

Query Parameters

start_after Start After

A cursor for use in pagination. start_after is an object ID that defines your place in the list.

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.

next Next Page (string)

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

data

object[]

required

List of charge objects

Array [

object Object (string)required

The type of object, in this case charge

id ID (string)required

A unique ID for this charge. usually starts with 'ch_', followed by an alphanumeric string.

amount Amount (integer)required

The amount of the charge

amount_refunded Amount Refunded (integer)required

The amount refunded

authorized Authorized (boolean)required

Whether an amount is authorized / held for future capturing.

captured Captured (boolean)required

Whether an authorized amount has been captured or not

currency Currency (string)required

3-letter ISO-code for currency.

statement_descriptor Statement Descriptor (string)required

The statement descriptor that will appear in the credit card statement

description Description (string)required

The description for this charge

source

object

required

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 Source Typerequired

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

The type of the source to create.

card

object

Card details of tokenized credit card.

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

Bank details of the tokenized account.

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

Information related to the redirect flow. Present if the source is authenticated by a redirect

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

require_auth Require Payer Authentication (boolean)

Default value: true

When set to false, attempt to do 3D secure authentication for credit card is bypassed and charge is immediately executed. This has no effect for vaulted cards.

owner object

Payment source owner details

action object

Tells the next action the client needs to make. Generally used for credit card, bank or wallet authentication.

refunds

object[]

required

A list of refunds, if applicable

Array [

object Object (string)required

The type of object, in this case refund

id ID (string)required

A unique ID for this refund. usually starts with 're_', followed by an alphanumeric string.

amount Amount (integer)required

The amount of the charge

currency Currency (string)required

3-letter ISO-code for currency.

reason Reason (string)required

Reason for the refund

status Status (string)required

The status of the refund

created_at Created Date (string)required

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

updated_at Updated Date (string)

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

]

status Status (string)required

The status of the charge

livemode Live Mode (boolean)required

Will be true if the secret key used was the live key, false if the test key was used

created_at Created Date (string)required

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

updated_at Updated Date (string)required

Latest time at which the object was updated in ISO 8601 format.

metadata object

failure_data object

A dictionary that contains error response from the provider.

]

Example (from schema)

{
  "object": "list",
  "next": "/v2/charges/?start_after=ch_0179ee1e0b12cb6430a04ee7ae103ee6",
  "data": [
    {
      "object": "charge",
      "id": "ch_0179504c16bddfe6bb8444581af5ae05",
      "amount": 5000,
      "amount_refunded": 0,
      "authorized": false,
      "captured": true,
      "currency": "PHP",
      "statement_descriptor": "Surf Rack",
      "description": "1 hour surf lesson",
      "source": {
        "object": "source",
        "id": "src_01786de4d9d69ad1369bfd56b098ccd9",
        "type": "card",
        "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": {}
      },
      "require_auth": false,
      "owner": {
        "name": "John Doe",
        "address_country": "PH"
      },
      "action": {
        "type": "redirect_to_url",
        "url": "https://api.magpie.im/v2/charges/auth/ra_0179082b7bf0afce5b5f7e445907198d/"
      },
      "refunds": [
        {
          "object": "refund",
          "id": "re_0179ee1e0b12cb6430a04ee7ae103ee6",
          "amount": 5000,
          "currency": "PHP",
          "reason": "Refund",
          "status": "succeeded",
          "created_at": "2021-04-12T13:55:54.194136+08:00",
          "updated_at": "2021-04-12T13:55:54.194136+08:00"
        }
      ],
      "status": "succeeded",
      "livemode": true,
      "created_at": "2021-04-12T13:55:54.194136+08:00",
      "updated_at": "2021-04-13T13:55:54.194136+08:00",
      "metadata": {},
      "failure_data": {
        "code": "authentication_required",
        "reason": "The card was declined as the transaction requires authentication.",
        "next_steps": "The customer should try again and authenticate their card when prompted during the transaction.",
        "provider_response": {}
      }
    }
  ]
}

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...