Skip to main content
GET
/
v1
/
payments
/
{id}
Get a payment
curl --request GET \
  --url https://api-sandbox.circle.com/v1/payments/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
    "type": "payment",
    "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
    "merchantWalletId": "212000",
    "amount": {
      "amount": "3.14",
      "currency": "USD"
    },
    "fromAmount": {
      "amount": "3.14",
      "currency": "EUR"
    },
    "source": {
      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
      "type": "card"
    },
    "description": "Payment",
    "status": "pending",
    "requiredAction": {
      "type": "three_d_secure_required",
      "redirectUrl": "https://example.org"
    },
    "verification": {
      "avs": "D",
      "cvv": "not_requested",
      "threeDSecure": "pass",
      "eci": "00"
    },
    "originalPayment": {
      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
      "type": "payment",
      "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
      "merchantWalletId": "212000",
      "amount": {
        "amount": "3.14",
        "currency": "USD"
      },
      "source": {
        "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
        "type": "card"
      },
      "description": "Payment",
      "status": "pending",
      "captured": false,
      "captureAmount": {
        "amount": "3.14",
        "currency": "USD"
      },
      "captureDate": "2020-04-10T02:13:30.000Z",
      "requiredAction": {
        "type": "three_d_secure_required",
        "redirectUrl": "https://example.org"
      },
      "cancel": {
        "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
        "type": "cancel",
        "description": "Payment",
        "status": "pending",
        "createDate": "2020-04-10T02:13:30.000Z"
      },
      "refunds": [
        {
          "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
          "type": "payment",
          "amount": {
            "amount": "3.14",
            "currency": "USD"
          },
          "description": "Payment",
          "status": "pending",
          "requiredAction": {
            "type": "three_d_secure_required",
            "redirectUrl": "https://example.org"
          },
          "fees": {
            "amount": "3.14",
            "currency": "USD"
          },
          "createDate": "2020-04-10T02:13:30.000Z"
        }
      ],
      "fees": {
        "amount": "3.14",
        "currency": "USD"
      },
      "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
      "createDate": "2020-04-10T02:13:30.000Z",
      "updateDate": "2020-04-10T02:13:30.000Z"
    },
    "cancel": {
      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
      "type": "cancel",
      "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
      "merchantWalletId": "212000",
      "amount": {
        "amount": "3.14",
        "currency": "USD"
      },
      "source": {
        "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
        "type": "card"
      },
      "description": "Payment",
      "status": "pending",
      "originalPayment": {
        "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
        "type": "payment",
        "amount": {
          "amount": "3.14",
          "currency": "USD"
        },
        "description": "Payment",
        "status": "pending",
        "requiredAction": {
          "type": "three_d_secure_required",
          "redirectUrl": "https://example.org"
        },
        "fees": {
          "amount": "3.14",
          "currency": "USD"
        },
        "createDate": "2020-04-10T02:13:30.000Z"
      },
      "fees": {
        "amount": "3.14",
        "currency": "USD"
      },
      "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
      "createDate": "2020-04-10T02:13:30.000Z",
      "updateDate": "2020-04-10T02:13:30.000Z"
    },
    "refunds": [
      {
        "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
        "type": "refund",
        "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
        "merchantWalletId": "212000",
        "amount": {
          "amount": "3.14",
          "currency": "USD"
        },
        "source": {
          "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
          "type": "card"
        },
        "description": "Payment",
        "status": "pending",
        "originalPayment": {
          "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
          "type": "payment",
          "amount": {
            "amount": "3.14",
            "currency": "USD"
          },
          "description": "Payment",
          "status": "pending",
          "requiredAction": {
            "type": "three_d_secure_required",
            "redirectUrl": "https://example.org"
          },
          "fees": {
            "amount": "3.14",
            "currency": "USD"
          },
          "createDate": "2020-04-10T02:13:30.000Z"
        },
        "cancel": {
          "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
          "type": "cancel",
          "description": "Payment",
          "status": "pending",
          "createDate": "2020-04-10T02:13:30.000Z"
        },
        "fees": {
          "amount": "3.14",
          "currency": "USD"
        },
        "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
        "createDate": "2020-04-10T02:13:30.000Z",
        "updateDate": "2020-04-10T02:13:30.000Z"
      }
    ],
    "fees": {
      "amount": "3.14",
      "currency": "USD"
    },
    "trackingRef": "24910599141085313498894",
    "externalRef": "YYYYMMDDXXXXXXXX012345",
    "errorCode": "payment_failed",
    "metadata": {
      "email": "satoshi@circle.com",
      "phoneNumber": "+14155555555"
    },
    "channel": "ba943ff1-ca16-49b2-ba55-1057e70ca5c7",
    "riskEvaluation": {
      "decision": "approved",
      "reason": "3000"
    },
    "createDate": "2020-04-10T02:13:30.000Z",
    "updateDate": "2020-04-10T02:13:30.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Universally unique identifier (UUID v4) of a resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

Response

Successfully retrieved a payment.

​
data
object
  • Option 1
  • Option 2