POST api/v1/payments/b2b/transaction/debit

Debit a customer's bank account.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Authentication		AuthenticationModel	Required
Request		TransactionBankRequestModel	Required

Request Formats

application/json, text/json

Sample:

{
  "Authentication": {
    "Id": "170200123",
    "Key": "467512342123"
  },
  "Request": {
    "AccountHolderName": "Bart Simpson",
    "Amount": "20.50 (include decimal places)",
    "Authorizer": "Sierra",
    "BankAccountNumber": "123456789",
    "Description": "Monthly subscription",
    "RoutingNumber": "12345678",
    "TransactionDateTime": "2025-04-19 08:29:17 (YYYY-MM-DD HH:MM:SS - UTC format)",
    "TransactionReference": "2343-0988 (unique for each transaction)",
    "TransactionType": "(6 - debit, 7 - credit)",
    "Email": "larry@newmedia.com (your email address)",
    "Discount": null,
    "Marketing": null,
    "RevenuePartner": null,
    "Name": null
  }
}

application/xml, text/xml

Sample:

<BankTransactionBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Payments.Api.Models">
  <Authentication>
    <Id>170200123</Id>
    <Key>467512342123</Key>
  </Authentication>
  <Request>
    <AccountHolderName>Bart Simpson</AccountHolderName>
    <Amount>20.50 (include decimal places)</Amount>
    <Authorizer>Sierra</Authorizer>
    <BankAccountNumber>123456789</BankAccountNumber>
    <Description>Monthly subscription</Description>
    <Discount i:nil="true" />
    <Email>larry@newmedia.com (your email address)</Email>
    <Marketing i:nil="true" />
    <Name i:nil="true" />
    <RevenuePartner i:nil="true" />
    <RoutingNumber>12345678</RoutingNumber>
    <TransactionDateTime>2025-04-19 08:29:17 (YYYY-MM-DD HH:MM:SS - UTC format)</TransactionDateTime>
    <TransactionReference>2343-0988 (unique for each transaction)</TransactionReference>
    <TransactionType>(6 - debit, 7 - credit)</TransactionType>
  </Request>
</BankTransactionBindingModel>

Response Information

Resource Description

BankTransactionOutgoingModel

Name	Description	Type	Additional information
Message		MessageModel	None.
Response		BankTransactionResponseModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": {
    "Code": "(2 digit code reflecting result of request - 00 is good)",
    "Description": "(Message response in text depending upon request/result of request)"
  },
  "Response": {
    "ResponseCode": "(0 - approved, 1 - declined, 2 - held for review, 3 - error)",
    "ResponseCodeText": "(Approved/Declined/Referred/Error/Error message)",
    "AuthCode": "B800ZS1 (value depending upon Authorizer used, may be null)",
    "TransactionReference": "2343-0988 (will match your transaction reference)",
    "TransactionID": "3212345",
    "DiscountedAmount": null
  }
}

application/xml, text/xml

Sample:

<BankTransactionOutgoingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Payments.Api.Models">
  <Message>
    <Code>(2 digit code reflecting result of request - 00 is good)</Code>
    <Description>(Message response in text depending upon request/result of request)</Description>
  </Message>
  <Response>
    <AuthCode>B800ZS1 (value depending upon Authorizer used, may be null)</AuthCode>
    <DiscountedAmount i:nil="true" />
    <ResponseCode>(0 - approved, 1 - declined, 2 - held for review, 3 - error)</ResponseCode>
    <ResponseCodeText>(Approved/Declined/Referred/Error/Error message)</ResponseCodeText>
    <TransactionID>3212345</TransactionID>
    <TransactionReference>2343-0988 (will match your transaction reference)</TransactionReference>
  </Response>
</BankTransactionOutgoingModel>