v1
latestOpenAPI 3.1.02026-07-24270180.3 KBQuery a payment
Search for all or a specific charge
get/v1/charges/{id}
Path parameters
idstring required
The charge ID returned at the creation stage. Omitting this will return a list of all charges
Query parameters
subscription_idstring
To fetch only those charges which are related to a particular subscription
gateway_idstring
To fetch only those charges which are created with a particular gateway
statusstring
To fetch only those charges which have a particular status. See Status table. It can be one or several statuses, separated by commas.
gateway_typestring
To fetch only those charges which have a particular gateway type. See Gateway types table. It can be one or several gateway types, separated by commas.
archivedstring
To fetch only archived charges. If set to true, it will show all the archived charges. Default: false
referencestring
To fetch only those charges which have a particular reference. transaction_external_id can also be used to search by reference
one_offstring
To fetch only one-off charges. If set to true, it will show charges without a subscription only. If set to false, it will show charges created by subscriptions only
amountstring
To fetch charges with a particular amount only
card_number_last4string
To fetch charges with particular last 4 digits in the payment source card number
authorizationstring
If set to true, it will filter charges followed authorization flow. If set to false, it will filter charges followed capture flow
Headers
x-user-secret-keystring required
Your API private/secret key. This can be found in the powerboard dashboard.
Content-Typestring required
Content-Type will always be application/json
Response
200
Example response
{
"status": 200,
"resource": {
"type": "charge",
"data": {
"_id": "5ec7b21cb12c99579e46f270",
"created_at": "2020-05-22T11:06:04.900Z",
"updated_at": "2020-05-22T11:06:06.000Z",
"remittance_date": "2020-05-23T11:06:06.000Z",
"company_id": "5cbeda664fdfb25772b5547f",
"user_id": "5cbeda664fdfb25772b5547e",
"amount": 1,
"currency": "AUD",
"subscription_id": "5ec7b20ab12c99579e46f26b",
"_source_ip_address": "127.0.0.1",
"transactions": [
{
"created_at": "2020-05-22T11:06:04.894Z",
"amount": 1,
"currency": "AUD",
"_id": "5ec7b21cb12c99579e46f271",
"_source_ip_address": "127.0.0.1",
"service_logs": [
{
"req": {
"format": "json",
"body": "{\"body\":{\"amount\":1,\"customerId\":\"536537284\",\"type\":\"sale\"}}"
},
"response_body": {
"format": "json",
"body": "{\"transaction\":{\"id\":\"b7vyt6xm\",\"status\":\"authorized\",\"type\":\"sale\",\"currencyIsoCode\":\"USD\",\"amount\":\"1.00\",\"merchantAccountId\":\"4cptn45444ks9cw4\",\"subMerchantAccountId\":null,\"masterMerchantAccountId\":null,\"orderId\":null,\"createdAt\":\"2020-05-22T11:06:05Z\",\"updatedAt\":\"2020-05-22T11:06:05Z\",\"customer\":{\"id\":\"536537284\",\"firstName\":null,\"lastName\":null,\"company\":null,\"email\":\"wanda.mertz@example.com\",\"website\":null,\"phone\":null,\"fax\":null,\"globalId\":\"Y3VzdG9tZXJfNTM2NTM3Mjg0\"},\"billing\":{\"id\":null,\"firstName\":null,\"lastName\":null,\"company\":null,\"streetAddress\":null,\"extendedAddress\":null,\"locality\":null,\"region\":null,\"postalCode\":null,\"countryName\":null,\"countryCodeAlpha2\":null,\"countryCodeAlpha3\":null,\"countryCodeNumeric\":null},\"refundId\":null,\"refundIds\":[],\"refundedTransactionId\":null,\"partialSettlementTransactionIds\":[],\"authorizedTransactionId\":null,\"settlementBatchId\":null,\"shipping\":{\"id\":null,\"firstName\":null,\"lastName\":null,\"company\":null,\"streetAddress\":null,\"extendedAddress\":null,\"locality\":null,\"region\":null,\"postalCode\":null,\"countryName\":null,\"countryCodeAlpha2\":null,\"countryCodeAlpha3\":null,\"countryCodeNumeric\":null},\"customFields\":\"\",\"avsErrorResponseCode\":null,\"avsPostalCodeResponseCode\":\"I\",\"avsStreetAddressResponseCode\":\"I\",\"cvvResponseCode\":\"I\",\"gatewayRejectionReason\":null,\"processorAuthorizationCode\":\"2783KW\",\"processorResponseCode\":\"1000\",\"processorResponseText\":\"Approved\",\"additionalProcessorResponse\":null,\"voiceReferralNumber\":null,\"purchaseOrderNumber\":null,\"taxAmount\":null,\"taxExempt\":false,\"creditCard\":{\"token\":\"8x6m7fg\",\"bin\":\"424242\",\"last4\":\"4242\",\"cardType\":\"Visa\",\"expirationMonth\":\"03\",\"expirationYear\":\"2020\",\"customerLocation\":\"US\",\"cardholderName\":\"Wanda Mertz\",\"imageUrl\":\"https://assets.braintreegateway.com/payment_method_logo/visa.png?environment=sandbox\",\"prepaid\":\"Unknown\",\"healthcare\":\"Unknown\",\"debit\":\"Unknown\",\"durbinRegulated\":\"Unknown\",\"commercial\":\"Unknown\",\"payroll\":\"Unknown\",\"issuingBank\":\"Unknown\",\"countryOfIssuance\":\"Unknown\",\"productId\":\"Unknown\",\"globalId\":\"cGF5bWVudG1ldGhvZF9jY184eDZtN2Zn\",\"accountType\":null,\"uniqueNumberIdentifier\":\"8a8e0755d14e2ee2a306f4788f4e480a\",\"venmoSdk\":false,\"maskedNumber\":\"424242******4242\",\"expirationDate\":\"03/2020\"},\"statusHistory\":[{\"timestamp\":\"2020-05-22T11:06:05Z\",\"status\":\"authorized\",\"amount\":\"1.00\",\"user\":\"juls\",\"transactionSource\":\"api\"}],\"planId\":null,\"subscriptionId\":null,\"subscription\":{\"billingPeriodEndDate\":null,\"billingPeriodStartDate\":null},\"addOns\":[],\"discounts\":[],\"descriptor\":{\"name\":null,\"phone\":null,\"url\":null},\"recurring\":false,\"channel\":null,\"serviceFeeAmount\":null,\"escrowStatus\":null,\"disbursementDetails\":{\"disbursementDate\":null,\"settlementAmount\":null,\"settlementCurrencyIsoCode\":null,\"settlementCurrencyExchangeRate\":null,\"fundsHeld\":null,\"success\":null},\"disputes\":[],\"authorizationAdjustments\":[],\"paymentInstrumentType\":\"credit_card\",\"processorSettlementResponseCode\":\"\",\"processorSettlementResponseText\":\"\",\"networkResponseCode\":\"XX\",\"networkResponseText\":\"sample network response text\",\"threeDSecureInfo\":null,\"shipsFromPostalCode\":null,\"shippingAmount\":null,\"discountAmount\":null,\"networkTransactionId\":\"020200522110605\",\"processorResponseType\":\"approved\",\"authorizationExpiresAt\":\"2020-05-29T11:06:05Z\",\"refundGlobalIds\":[],\"partialSettlementTransactionGlobalIds\":[],\"refundedTransactionGlobalId\":null,\"authorizedTransactionGlobalId\":null,\"globalId\":\"dHJhbnNhY3Rpb25fYjd2eXQ2eG0\",\"retryIds\":[],\"retriedTransactionId\":null,\"retrievalReferenceNumber\":\"1234567\",\"paypalAccount\":{},\"coinbaseAccount\":{},\"applePayCard\":{},\"androidPayCard\":{}},\"success\":true}"
}
}
],
"status": "complete",
"type": "sale"
}
],
"customer": {
"customer_id": "5ec7b209b12c99579e46f268",
"email": "wanda.mertz@example.com",
"payment_source": {
"type": "card",
"card_name": "Wanda Mertz",
"card_number_last4": "4242",
"card_number_bin": "42424242",
"card_scheme": "visa",
"expire_month": 3,
"expire_year": 2020,
"address_country": "AU",
"gateway_id": "5cffefaa18b6546015794998"
}
},
"capture": true,
"status": "complete",
"external_id": "b7vyt6xm"
}
}
}