Jump to Content

v1.0

API Reference

v1.0

Gateway

/purchases/{id}/capture
- Capture an authorizationpost
/purchases
- Create a purchasepost
- List purchasesget
/purchases/void?id={id}
- Void a purchasepost
/purchases/{id}
/direct_credits
- List direct creditsget
- Create a direct creditpost
/purchases/settlement
- List purchases by settlementget
/direct_credits/{id_or_reference}
- Fetch a direct creditget
/direct_credits/{id}
- Delete a direct creditdel
- Update a direct creditput
/customers/{id}
/customers
- List customersget
- Create a customerpost
/applicable_surcharge
- Get applicable surchargeget
/refunds/{id}
- Fetch a refundget
/web_hooks/{id}
- Delete a webhookdel
- Update a webhookput
/web_hooks
- Create a webhookpost
- List webhooksget
/credit_cards/{token_or_alias}
- Update a tokenized cardput
- Fetch a tokenized cardget
/bank_accounts
- Create a bank accountpost
- List bank accountsget
/credit_cards
- List tokenized cardsget
- Tokenize a cardpost
/refunds
- Issue a refundpost
- List refundsget
/batches/{filename}
- Create a batchpost
/batches
- List all batchesget
/batches/{id}
- Fetch a batchget
- Delete a batchdel
/payment_plans
- Create a payment planpost
- List payment plansget
/settlement/totals
- Fetch settlement totalsget
/direct_debits/{id_or_reference}
- Fetch a direct debitget
/direct_debits/{id}
- Update a direct debitput
- Delete a direct debitdel
/invoice_imports/4a70e8d5-1d7d-441d-9ea2-30d15ff0f2e8
- Check replacement statusget
/invoices/{reference}
- Fetch an invoiceget
/direct_debits
- List direct debitsget
- Create a direct debitpost
/invoices
- Replace all invoicesput
/purchases/////
- Create an authorizationpost
/refunds/void
- Void a refundpost
/payment_plans/{id_or_reference}
/chargebacks/{id}
- Fetch a chargebackget
- Update a chargebackpatch
/chargebacks
- List chargebacksget
/chargebacks/{chargeback_id}/notifications/{id}
- Update a chargeback notificationpatch
- Fetch a chargeback notificationget
/chargebacks/{id}/notifications
- List chargeback notificationsget
/bank_accounts/{id}
- Fetch a bank accountget
/purchases/
- Create a purchase using a walletpost
/purchases////
- Create a purchase, with fraud screeningpost
/batches/{id}/result.csv
- Retrieve batch result fileget
/purchases//
- Create a purchase with fraud screeningpost
/credit_cards/
- Tokenize a card with wallet credentialspost
/purchases///
- Create a purchase with a tokenpost
/authenticate/session
- Generate a JWT tokenpost
/authenticate/decode_session
- Decode a JWT tokenget
/authenticate
- Authenticate a transactionpost
/paypal/orders
- List ordersget
/paypal/orders/{id}
- Fetch an orderget
/paypal/authorizations
- List authorizationsget
/paypal/authorizations/{id}
- Fetch an authorizationget
/paypal/captures
- List capturesget
/paypal/captures/{id}
- Fetch a captureget
/paypal/refunds
- List refundsget
/paypal/refunds/{id}
- Fetch a refundget
/paypal/billing_agreements
- List billing agreementsget
/paypal/billing_agreements/{id}
- Fetch a billing agreementget
/paypal/billing_agreements/{id}/cancel
- Cancel a billing agreementpost
/paypal/billing_agreements/{id}/charge
- Charge a billing agreementpost
/paypal/captures/{id}/refund
- Refund a capturepost
/paypal/authorizations/{id}/capture
- Capture an authorizationpost
/paypal/authorizations/{id}/void
- Void an authorizationpost

Apple Pay

Apple Pay
Setup your Apple Merchant ID
Get Apple Pay Session
Recurring & Installment Transactions

Google Pay™

Google Pay™
Android App Integration
Web Integration
Hosted Payments Page Integration

HOSTED PAYMENT PAGES

Overview

TESTING

Test Card Numbers

3DS2 INTEGRATION

Overview
Using Hosted Payments Page
Using Custom Payments Form
Testing
Branding Requirements
Go-Live

Powered by

Fetch a billing agreement

get

https://gateway.pmnts-sandbox.io/v1.0/paypal/billing_agreements/{id}

Language

Credentials

Query

Click Try It! to start a request and see the response here!