Charge a stored card

Charges a card the customer has already saved. There's no payment form: BillPro charges the card straight away. The card also becomes the order's card.

Set operation to choose what to charge:

  • initial_payment: the order's first payment. Use it on an order whose status is draft, pending or rejected. If the order has nothing to collect up front, BillPro checks the card with a 0.00 pre-authorisation and saves it on the order. payment.transaction_type is pa.
  • recover_failed_payments: every payment that's due and unpaid. That's each scheduled payment that failed, was rejected, or passed its date without being collected. They're merged into one payment for the total and charged now.

A paid single payment order moves to complete. Other order types move to active.

A declined card returns 200 with result.successful: false, not an error. result.message says why.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

Your merchant profile ID. Required in every request.

Find it in the BillPro dashboard address, after /profiles/. For example, in /profiles/1234/orders the profile ID is 1234.

string
required

ID of the order.

Body Params
string
enum
required

What to charge. initial_payment: the order's first payment. recover_failed_payments: every payment that's due and unpaid, merged into one.

Allowed:
integer
required

ID of one of the customer's saved cards, such as 311. Get it from List customer cards. It must belong to the order's customer.

Responses

Language
Credentials
Bearer
API token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json