NAnatural
Card Payments

Get card payment

Changed on

Get one card payment attempt, including its status, failure details, and refund totals.

get/card-payments/{cardPaymentId}

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/card-payments/{cardPaymentId}
  • Auth
    HTTP bearer

Path parameters

cardPaymentIdstring required

Card payment ID (cpy_*).

Query parameters

customerPartyIdstring

Customer party to act for (pty_*). Omit for your own account. Requires authorization from that customer.

Headers

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response

Changes

  • 46c3e5516668Revision changes
    • warning

      added the new api enum value to the // response property for the response status

    • warning

      added the new authorized enum value to the // response property for the response status

    • warning

      added the new canceled enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

  • 84d3e68026cfRevision changes
    • info

      added the required property // to the response with the status