Billing Platform API
Billing Platform API
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/PAYMENT/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "PaymentGatewayProfileId": 0, "EcomTransactionId": 0, "GatewayTransactionId": "string", "UpdatedUserId": "string", "VoidWithoutGateway": 0, "CheckNumber": "string", "GatewayTransactionStatus": "string", "GatewayTransactionStatusDate": "string", "Created": "string", "EcomTransactionResponseId": 0, "PaymentType": "string", "VoidedPaymentId": 0, "CreditCardTransactionMessage": "string", "LateApprovedBy": 0, "AllocatedToExtAccount": "string", "PayoutId": "string", "Updated": "string", "ExternalReferenceId": "string", "PaymentNote": "string", "Id": "string", "PaymentDate": "string", "CreatedUserId": "string", "AccountingPeriodId": 0, "VoidFlag": "string", "CreditCardTransactionStatus": "string", "Autoallocate": 0, "SourcePaymentId": 0, "PaymentAllocationStrategy": "string", "CreditCardTransactionStatusCode": "string", "OperatorId": "string", "SinglePaymentGroup": "string", "HostedPaymentPageExternalId": "string", "BillingProfileId": 0, "InvoiceIdDisplay": "string", "CreditCardExpDate": "string", "CreditCardName": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "PendingAmount": "string", "CreditCardType": "string", "AchBankAcctNum": "string", "Address1": "string", "City": "string", "State": "string", "Country": "string", "Zip": "string", "LockboxRecordId": 0, "ApproveInvoiceId": 0, "CreditCardToken": "string", "WalletId": 0, "AchToken": "string" } }
curl -i -X GET \ 'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/PAYMENT?queryAnsiSql=string' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'sessionId: string'
{ "retrieveResponse": { "PaymentGatewayProfileId": 0, "EcomTransactionId": 0, "GatewayTransactionId": "string", "UpdatedUserId": "string", "VoidWithoutGateway": 0, "CheckNumber": "string", "GatewayTransactionStatus": "string", "GatewayTransactionStatusDate": "string", "Created": "string", "EcomTransactionResponseId": 0, "PaymentType": "string", "VoidedPaymentId": 0, "CreditCardTransactionMessage": "string", "LateApprovedBy": 0, "AllocatedToExtAccount": "string", "PayoutId": "string", "Updated": "string", "ExternalReferenceId": "string", "PaymentNote": "string", "Id": "string", "PaymentDate": "string", "CreatedUserId": "string", "AccountingPeriodId": 0, "VoidFlag": "string", "CreditCardTransactionStatus": "string", "Autoallocate": 0, "SourcePaymentId": 0, "PaymentAllocationStrategy": "string", "CreditCardTransactionStatusCode": "string", "OperatorId": "string", "SinglePaymentGroup": "string", "HostedPaymentPageExternalId": "string", "BillingProfileId": 0, "InvoiceIdDisplay": "string", "CreditCardExpDate": "string", "CreditCardName": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "PendingAmount": "string", "CreditCardType": "string", "AchBankAcctNum": "string", "Address1": "string", "City": "string", "State": "string", "Country": "string", "Zip": "string", "LockboxRecordId": 0, "ApproveInvoiceId": 0, "CreditCardToken": "string", "WalletId": 0, "AchToken": "string" } }
curl -i -X POST \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/PAYMENT \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "PaymentGatewayProfileId": 0, "EcomTransactionId": 0, "GatewayTransactionId": "string", "UpdatedUserId": "string", "VoidWithoutGateway": 0, "CheckNumber": "string", "GatewayTransactionStatus": "string", "GatewayTransactionStatusDate": "string", "Created": "string", "EcomTransactionResponseId": 0, "PaymentType": "string", "VoidedPaymentId": 0, "CreditCardTransactionMessage": "string", "LateApprovedBy": 0, "AllocatedToExtAccount": "string", "PayoutId": "string", "Updated": "string", "ExternalReferenceId": "string", "PaymentNote": "string", "Id": "string", "PaymentDate": "string", "CreatedUserId": "string", "AccountingPeriodId": 0, "VoidFlag": "string", "CreditCardTransactionStatus": "string", "Autoallocate": 0, "SourcePaymentId": 0, "PaymentAllocationStrategy": "string", "CreditCardTransactionStatusCode": "string", "OperatorId": "string", "SinglePaymentGroup": "string", "HostedPaymentPageExternalId": "string", "BillingProfileId": 0, "InvoiceIdDisplay": "string", "CreditCardExpDate": "string", "CreditCardName": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "PendingAmount": "string", "CreditCardType": "string", "AchBankAcctNum": "string", "Address1": "string", "City": "string", "State": "string", "Country": "string", "Zip": "string", "LockboxRecordId": 0, "ApproveInvoiceId": 0, "CreditCardToken": "string", "WalletId": 0, "AchToken": "string" } }'
{ "retrieveResponse": { "PaymentGatewayProfileId": 0, "EcomTransactionId": 0, "GatewayTransactionId": "string", "UpdatedUserId": "string", "VoidWithoutGateway": 0, "CheckNumber": "string", "GatewayTransactionStatus": "string", "GatewayTransactionStatusDate": "string", "Created": "string", "EcomTransactionResponseId": 0, "PaymentType": "string", "VoidedPaymentId": 0, "CreditCardTransactionMessage": "string", "LateApprovedBy": 0, "AllocatedToExtAccount": "string", "PayoutId": "string", "Updated": "string", "ExternalReferenceId": "string", "PaymentNote": "string", "Id": "string", "PaymentDate": "string", "CreatedUserId": "string", "AccountingPeriodId": 0, "VoidFlag": "string", "CreditCardTransactionStatus": "string", "Autoallocate": 0, "SourcePaymentId": 0, "PaymentAllocationStrategy": "string", "CreditCardTransactionStatusCode": "string", "OperatorId": "string", "SinglePaymentGroup": "string", "HostedPaymentPageExternalId": "string", "BillingProfileId": 0, "InvoiceIdDisplay": "string", "CreditCardExpDate": "string", "CreditCardName": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "PendingAmount": "string", "CreditCardType": "string", "AchBankAcctNum": "string", "Address1": "string", "City": "string", "State": "string", "Country": "string", "Zip": "string", "LockboxRecordId": 0, "ApproveInvoiceId": 0, "CreditCardToken": "string", "WalletId": 0, "AchToken": "string" } }
curl -i -X PUT \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/PAYMENT \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "PaymentGatewayProfileId": 0, "EcomTransactionId": 0, "GatewayTransactionId": "string", "UpdatedUserId": "string", "VoidWithoutGateway": 0, "CheckNumber": "string", "GatewayTransactionStatus": "string", "GatewayTransactionStatusDate": "string", "Created": "string", "EcomTransactionResponseId": 0, "PaymentType": "string", "VoidedPaymentId": 0, "CreditCardTransactionMessage": "string", "LateApprovedBy": 0, "AllocatedToExtAccount": "string", "PayoutId": "string", "Updated": "string", "ExternalReferenceId": "string", "PaymentNote": "string", "Id": "string", "PaymentDate": "string", "CreatedUserId": "string", "AccountingPeriodId": 0, "VoidFlag": "string", "CreditCardTransactionStatus": "string", "Autoallocate": 0, "SourcePaymentId": 0, "PaymentAllocationStrategy": "string", "CreditCardTransactionStatusCode": "string", "OperatorId": "string", "SinglePaymentGroup": "string", "HostedPaymentPageExternalId": "string", "BillingProfileId": 0, "InvoiceIdDisplay": "string", "CreditCardExpDate": "string", "CreditCardName": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "PendingAmount": "string", "CreditCardType": "string", "AchBankAcctNum": "string", "Address1": "string", "City": "string", "State": "string", "Country": "string", "Zip": "string", "LockboxRecordId": 0, "ApproveInvoiceId": 0, "CreditCardToken": "string", "WalletId": 0, "AchToken": "string" } }'
{ "retrieveResponse": { "PaymentGatewayProfileId": 0, "EcomTransactionId": 0, "GatewayTransactionId": "string", "UpdatedUserId": "string", "VoidWithoutGateway": 0, "CheckNumber": "string", "GatewayTransactionStatus": "string", "GatewayTransactionStatusDate": "string", "Created": "string", "EcomTransactionResponseId": 0, "PaymentType": "string", "VoidedPaymentId": 0, "CreditCardTransactionMessage": "string", "LateApprovedBy": 0, "AllocatedToExtAccount": "string", "PayoutId": "string", "Updated": "string", "ExternalReferenceId": "string", "PaymentNote": "string", "Id": "string", "PaymentDate": "string", "CreatedUserId": "string", "AccountingPeriodId": 0, "VoidFlag": "string", "CreditCardTransactionStatus": "string", "Autoallocate": 0, "SourcePaymentId": 0, "PaymentAllocationStrategy": "string", "CreditCardTransactionStatusCode": "string", "OperatorId": "string", "SinglePaymentGroup": "string", "HostedPaymentPageExternalId": "string", "BillingProfileId": 0, "InvoiceIdDisplay": "string", "CreditCardExpDate": "string", "CreditCardName": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "PendingAmount": "string", "CreditCardType": "string", "AchBankAcctNum": "string", "Address1": "string", "City": "string", "State": "string", "Country": "string", "Zip": "string", "LockboxRecordId": 0, "ApproveInvoiceId": 0, "CreditCardToken": "string", "WalletId": 0, "AchToken": "string" } }
curl -i -X PATCH \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/PAYMENT \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "PaymentGatewayProfileId": 0, "EcomTransactionId": 0, "GatewayTransactionId": "string", "UpdatedUserId": "string", "VoidWithoutGateway": 0, "CheckNumber": "string", "GatewayTransactionStatus": "string", "GatewayTransactionStatusDate": "string", "Created": "string", "EcomTransactionResponseId": 0, "PaymentType": "string", "VoidedPaymentId": 0, "CreditCardTransactionMessage": "string", "LateApprovedBy": 0, "AllocatedToExtAccount": "string", "PayoutId": "string", "Updated": "string", "ExternalReferenceId": "string", "PaymentNote": "string", "Id": "string", "PaymentDate": "string", "CreatedUserId": "string", "AccountingPeriodId": 0, "VoidFlag": "string", "CreditCardTransactionStatus": "string", "Autoallocate": 0, "SourcePaymentId": 0, "PaymentAllocationStrategy": "string", "CreditCardTransactionStatusCode": "string", "OperatorId": "string", "SinglePaymentGroup": "string", "HostedPaymentPageExternalId": "string", "BillingProfileId": 0, "InvoiceIdDisplay": "string", "CreditCardExpDate": "string", "CreditCardName": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "PendingAmount": "string", "CreditCardType": "string", "AchBankAcctNum": "string", "Address1": "string", "City": "string", "State": "string", "Country": "string", "Zip": "string", "LockboxRecordId": 0, "ApproveInvoiceId": 0, "CreditCardToken": "string", "WalletId": 0, "AchToken": "string" }, "externalIDFieldName": "HostedPaymentPageExternalId" }'
{ "upsertResponse": [ { … } ] }
curl -i -X DELETE \ https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/delete/PAYMENT \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'sessionId: string' \ -d '{ "brmObjects": { "Id": "string" } }'
{ "retrieveResponse": { "PaymentGatewayProfileId": 0, "EcomTransactionId": 0, "GatewayTransactionId": "string", "UpdatedUserId": "string", "VoidWithoutGateway": 0, "CheckNumber": "string", "GatewayTransactionStatus": "string", "GatewayTransactionStatusDate": "string", "Created": "string", "EcomTransactionResponseId": 0, "PaymentType": "string", "VoidedPaymentId": 0, "CreditCardTransactionMessage": "string", "LateApprovedBy": 0, "AllocatedToExtAccount": "string", "PayoutId": "string", "Updated": "string", "ExternalReferenceId": "string", "PaymentNote": "string", "Id": "string", "PaymentDate": "string", "CreatedUserId": "string", "AccountingPeriodId": 0, "VoidFlag": "string", "CreditCardTransactionStatus": "string", "Autoallocate": 0, "SourcePaymentId": 0, "PaymentAllocationStrategy": "string", "CreditCardTransactionStatusCode": "string", "OperatorId": "string", "SinglePaymentGroup": "string", "HostedPaymentPageExternalId": "string", "BillingProfileId": 0, "InvoiceIdDisplay": "string", "CreditCardExpDate": "string", "CreditCardName": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "PendingAmount": "string", "CreditCardType": "string", "AchBankAcctNum": "string", "Address1": "string", "City": "string", "State": "string", "Country": "string", "Zip": "string", "LockboxRecordId": 0, "ApproveInvoiceId": 0, "CreditCardToken": "string", "WalletId": 0, "AchToken": "string" } }