Dime Payments API Documentation

List Merchants

GET

https://app.dimepayments.com

/api/merchant/list

requires authentication

Get a list of all merchants and their fields

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

filters

object

Response Fields

name

The name of the merchant.

sid

The unique Dime Payments ID for the merchant.

mcc

The MCC Code assigned to the merchant.

slug

The unique address for the merchant's pay page. i.e. https://dimepayments.com/{slug}.

pub_api_key

The public API key for the gateway's tokenizer.

active

boolean

If this merchant is active on Dime Payments.

active_at

date The date the merchant was made active.

g_pay

boolean

If this merchant is active on Google Pay.

a_pay

boolean

If this merchant is active on Apple Pay.

pci_compliance

boolean

If this merchant has an active AoC on file with Dime Payments.

website

The merchant's website.

addr1

The merchant's first address line.

addr2

The merchant's second address line (optional).

city

The merchant's city.

state

The merchant's state.

zip

The merchant's zip code.

phone

The merchant's phone number.

primary_phone

The merchant's primary contact phone number.

primary_email

The merchant's primary email address.

primary_name

The merchant's primary full name.

Example request:

curl --request GET \
    --get "https://app.dimepayments.com/api/merchant/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filters\": {
        \"start_date\": \"2024-01-01 00:00:00\",
        \"end_date\": \"2024-12-31 23:59:59\"
    }
}"

Example response:

{
"data": [
 {
     "name": "Streich, Kub and Steuber",
     "sid": "000010",
     "mcc": "8661",
     "slug": "deleniti-sunt-at-unde",
     "pub_api_key": "pub_1zBYuKWfl4hvL71yOt40lM3QfMf",
     "processor_mid": null,
     "active": true,
     "active_at": null,
     "g_pay": false,
     "a_pay": false,
     "pci_compliance": false,
     "website": null,
     "addr1": null,
     "addr2": null,
     "addr3": null,
     "city": null,
     "state": null,
     "zip": null,
     "phone": null,
     "contracted_date": null,
     "primary_phone": null,
     "payment_token": null,
     "primary_email": null,
     "primary_name": null
},
{
     "name": "Kling, McGlynn and McKenzie",
     "sid": "000002",
     "mcc": "8661",
     "slug": "sint-inventore-cum-tempore",
     "pub_api_key": "pkapi_cert_CjsyGGXamvz9xxcrri",
     "processor_mid": "",
     "active": true,
     "active_at": null,
     "g_pay": true,
     "a_pay": true,
     "pci_compliance": true,
     "website": "https:\/\/www.google.com",
     "addr1": "78686 hjgjgj gjh",
     "addr2": "hkjhk 7777",
     "addr3": "",
     "city": "city",
     "state": "GA",
     "zip": "30303",
     "phone": "7707892072",
     "contracted_date": null,
     "primary_phone": "7707892072",
     "payment_token": null,
     "primary_email": "[email protected]",
     "primary_name": "Ryan Taylor"
 },

Show a specific Merchant's Details

GET

https://app.dimepayments.com

/api/merchant/show

requires authentication

List all non-protected fields for a merchant. Other fields are available using their specific requests.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

Response Fields

name

string

The name of the merchant.

sid

string

The unique Dime Payments ID for the merchant.

mcc

string

The MCC Code assigned to the merchant.

slug

string

The unique address for the merchant's pay page. i.e. https://dimepayments.com/{slug}.

pub_api_key

string

The public API key for the gateway's tokenizer.

active

boolean

If this merchant is active on Dime Payments.

active_at

date The date the merchant was made active.

g_pay

boolean

If this merchant is active on Google Pay.

a_pay

boolean

If this merchant is active on Apple Pay.

pci_compliance

boolean

If this merchant has an active AoC on file with Dime Payments.

website

string

The merchant's website.

addr1

string

The merchant's first address line.

addr2

string

The merchant's second address line (optional).

city

string

The merchant's city.

state

string

The merchant's state.

zip

string

The merchant's zip code.

phone

string

The merchant's phone number.

primary_phone

string

The merchant's primary contact phone number.

primary_email

string

The merchant's primary email address.

primary_name

string

The merchant's primary full name.

Example request:

curl --request GET \
    --get "https://app.dimepayments.com/api/merchant/show" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": \"1234567\"
    }
}"

Example response:

{
    "data": {
        "name": "Dime Payments",
        "sid": "00001",
        "mcc": "8999",
        "slug": "pay",
        "pub_api_key": "pkapi_prod_B5n2hQhy6uAp1rLjqs",
        "processor_mid": "650000012366624",
        "active": true,
        "active_at": null,
        "g_pay": false,
        "a_pay": false,
        "pci_compliance": true,
        "website": "https://dimepayments.com",
        "addr1": "53 S. Main St",
        "addr2": "",
        "city": "Alpharetta",
        "state": "GA",
        "zip": "30009",
        "phone": "4049064975",
        "primary_phone": "4049064975",
        "primary_email": "[email protected]",
        "primary_name": "Ben Habeck"
    }
}

Create Merchant

POST

https://app.dimepayments.com

/api/merchant/create

requires authentication

Create a merchant record which can be used for generating an application.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

name

string

required

The name of the Merchant. Avoid special characters like \ or '.

Example:

Acme Inc

slug

string

required

Must be unique and HTML URL Compliant.

Example:

acme-inc

mcc

integer

required

Must be 4 digits and pre-approved by Dime Payments.

Example:

8661

processor_config_one

string

required

Must be on approved list, this is provided by your Dime Payments Rep.

Example:

Tier1

website

string

required

Must be a valid full URL.

Example:

https://acme-inc.com

addr1

string

required

Address line 1 of the Merchant.

Example:

123 4th Street

addr2

string

optional Address line 2 of the Merchant.

Example:

Suite 5

city

string

required

The city of the Merchant.

Example:

Alpharetta

state

string

required

The state abbreviation of teh Merchant.

Example:

GA

zip

integer

required

The 5-digit zip of the Merchant.

Example:

30009

phone

string

required

The main phone number for the Merchant in e164 format.

Example:

+177012345678

primary_phone

string

required

The phone of the main contact for the Merchant in e164 format.

Example:

+140412345678

primary_name

string

required

The full name of the main contact for the Merchant.

Example:

John Doe

primary_email

string

required

The email of the main contact for the Merchant.

Example:

[email protected]

industry

string

required

Must be a supported Industry name, contact Dime Payments Rep for values.

Example:

Church

Response Fields

name

string

The name of the merchant.

sid

string

The unique Dime Payments ID for the merchant.

mcc

string

The MCC Code assigned to the merchant.

slug

string

The unique address for the merchant's pay page. i.e. https://dimepayments.com/{slug}.

pub_api_key

string

The public API key for the gateway's tokenizer.

active

boolean

If this merchant is active on Dime Payments.

active_at

date The date the merchant was made active.

g_pay

boolean

If this merchant is active on Google Pay.

a_pay

boolean

If this merchant is active on Apple Pay.

pci_compliance

boolean

If this merchant has an active AoC on file with Dime Payments.

website

string

The merchant's website.

addr1

string

The merchant's first address line.

addr2

string

The merchant's second address line (optional).

city

string

The merchant's city.

state

string

The merchant's state.

zip

string

The merchant's zip code.

phone

string

The merchant's phone number.

primary_phone

string

The merchant's primary contact phone number.

primary_email

string

The merchant's primary email address.

primary_name

string

The merchant's primary full name.

Example request:

curl --request POST \
    "https://app.dimepayments.com/api/merchant/create" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"name\": \"Acme Inc\",
        \"slug\": \"acme-inc\",
        \"mcc\": 8661,
        \"processor_config_one\": \"Tier1\",
        \"website\": \"https:\\/\\/acme-inc.com\",
        \"addr1\": \"123 4th Street\",
        \"addr2\": \"Suite 5\",
        \"city\": \"Alpharetta\",
        \"state\": \"GA\",
        \"zip\": 30009,
        \"phone\": \"+177012345678\",
        \"primary_phone\": \"+140412345678\",
        \"primary_name\": \"John Doe\",
        \"primary_email\": \"[email protected]\",
        \"industry\": \"Church\"
    }
}"

Example response:

{
    "data": {
        "name": "Dime Payments",
        "sid": "00001",
        "mcc": "8999",
        "slug": "pay",
        "pub_api_key": "pkapi_prod_B5n2hQhy6uAp1rLjqs",
        "processor_mid": "650000012366624",
        "active": true,
        "active_at": null,
        "g_pay": false,
        "a_pay": false,
        "pci_compliance": true,
        "website": "https://dimepayments.com",
        "addr1": "53 S. Main St",
        "addr2": "",
        "city": "Alpharetta",
        "state": "GA",
        "zip": "30009",
        "phone": "4049064975",
        "primary_phone": "4049064975",
        "primary_email": "[email protected]",
        "primary_name": "Ben Habeck"
    }
}

Update a specific Merchant's Details

PATCH

https://app.dimepayments.com

/api/merchant/update

requires authentication

Update a Merchant's details.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

sid

integer

required

The SID of the Merchant to update.

Example:

99

slug

string

required

Must be unique and HTML URL Compliant.

Example:

acme-inc

name

string

required

The name of the Merchant. Avoid special characters like \ or '.

Example:

Acme Inc

mcc

integer

required

Must be 4 digits and pre-approved by Dime Payments.

Example:

8661

processor_config_one

string

required

Must be on approved list, this is provided by your Dime Payments Rep.

Example:

Tier1

website

string

required

Must be a valid full URL.

Example:

https://acme-inc.com

addr1

string

required

Address line 1 of the Merchant.

Example:

123 4th Street

addr2

string

optional Address line 2 of the Merchant.

Example:

Suite 5

city

string

required

The city of the Merchant.

Example:

Alpharetta

state

string

required

The state abbreviation of teh Merchant.

Example:

GA

zip

integer

required

The 5-digit zip of the Merchant.

Example:

30009

phone

string

required

The main phone number for the Merchant in e164 format.

Example:

+177012345678

primary_phone

string

required

The phone of the main contact for the Merchant in e164 format.

Example:

+140412345678

primary_name

string

required

The full name of the main contact for the Merchant.

Example:

John Doe

primary_email

string

required

The email of the main contact for the Merchant.

Example:

[email protected]

industry

string

required

Must be a supported Industry name, contact Dime Payments Rep for values.

Example:

Church

Response Fields

name

string

The name of the merchant.

sid

string

The unique Dime Payments ID for the merchant.

mcc

string

The MCC Code assigned to the merchant.

slug

string

The unique address for the merchant's pay page. i.e. https://dimepayments.com/{slug}.

pub_api_key

string

The public API key for the gateway's tokenizer.

active

boolean

If this merchant is active on Dime Payments.

active_at

date The date the merchant was made active.

g_pay

boolean

If this merchant is active on Google Pay.

a_pay

boolean

If this merchant is active on Apple Pay.

pci_compliance

boolean

If this merchant has an active AoC on file with Dime Payments.

website

string

The merchant's website.

addr1

string

The merchant's first address line.

addr2

string

The merchant's second address line (optional).

city

string

The merchant's city.

state

string

The merchant's state.

zip

string

The merchant's zip code.

phone

string

The merchant's phone number.

primary_phone

string

The merchant's primary contact phone number.

primary_email

string

The merchant's primary email address.

primary_name

string

The merchant's primary full name.

Example request:

curl --request PATCH \
    "https://app.dimepayments.com/api/merchant/update" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": 99,
        \"slug\": \"acme-inc\",
        \"name\": \"Acme Inc\",
        \"mcc\": 8661,
        \"processor_config_one\": \"Tier1\",
        \"website\": \"https:\\/\\/acme-inc.com\",
        \"addr1\": \"123 4th Street\",
        \"addr2\": \"Suite 5\",
        \"city\": \"Alpharetta\",
        \"state\": \"GA\",
        \"zip\": 30009,
        \"phone\": \"+177012345678\",
        \"primary_phone\": \"+140412345678\",
        \"primary_name\": \"John Doe\",
        \"primary_email\": \"[email protected]\",
        \"industry\": \"Church\"
    }
}"

Example response:

{
    "data": {
        "name": "Dime Payments",
        "sid": "00001",
        "mcc": "8999",
        "slug": "pay",
        "pub_api_key": "pkapi_prod_B5n2hQhy6uAp1rLjqs",
        "processor_mid": "650000012366624",
        "active": true,
        "active_at": null,
        "g_pay": false,
        "a_pay": false,
        "pci_compliance": true,
        "website": "https://dimepayments.com",
        "addr1": "53 S. Main St",
        "addr2": "",
        "city": "Alpharetta",
        "state": "GA",
        "zip": "30009",
        "phone": "4049064975",
        "primary_phone": "4049064975",
        "primary_email": "[email protected]",
        "primary_name": "Ben Habeck"
    }
}

Get a unique, secure link to the signup application for a Merchant.

GET

https://app.dimepayments.com

/api/merchant/get-form-link

requires authentication

Passed a merchant's ID, returns a full URL to the application for processor approval. This link expires in 48 hours.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

Response Fields

link

The https secure link for the Merchant application that expires in 48 hours.

Example request:

curl --request GET \
    --get "https://app.dimepayments.com/api/merchant/get-form-link" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": 69
    }
}"

Example response:

{
   "data": [
    {
        "link": "https://app.dimepayments.com/some/link",
   }

List Transactions

GET

https://app.dimepayments.com

/api/transactions

requires authentication

Retrieves a list of transactions for a given Merchant, filtered by various parameters.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

filters

object

start_date

date

The start date for filtering transactions in Y-m-d H:i:s format.

Example:

2021-01-01 00:00:00

end_date

date

The end date for filtering transactions in Y-m-d H:i:s format.

Example:

2021-12-31 23:59:59

sweep_id

string

The sweep ID of the transaction.

Example:

sweep_123*

customer_uuid

string

The customer UUID associated with the transaction.

Example:

cust_456

Response Fields

data

object

transaction_type

Transaction type. Example: Checking

transaction_status

Transaction Status. Example: CC Pending

transaction_status_description

Transaction Status. Example: A transaction that has not cleared yet

transaction_date

Transaction Date. Example: 2024-01-17T12:44:28.000000Z

fund_date

Fund Date. Example: 2024-01-18T21:05:21.000000Z

settle_date

Settle Date. Example: 2024-01-17T18:35:00.000000Z

amount

Transaction amount. Example: $120.00

customer_uuid

The unique UUID of the merchant's customer.

description

Transaction type. Example: Checking

billing_address

object

first_name

The first name field.

last_name

The last name field.

addr1

The first address line.

addr2

The second address line.

city

The city field.

state

The state field.

zip

The zip field.

Example request:

curl --request GET \
    --get "https://app.dimepayments.com/api/transactions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": \"12345\"
    },
    \"filters\": {
        \"start_date\": \"2021-01-01 00:00:00\",
        \"end_date\": \"2021-12-31 23:59:59\",
        \"sweep_id\": \"sweep_123*\",
        \"customer_uuid\": \"cust_456\"
    }
}"

Example response:

{
   "data": [
      {
          "transaction_type": "CC",
        "transaction_status": "CC Pending",
         "transaction_status_description": "A transaction that has not cleared yet",
        "transaction_number": "",
        "amount": "25.0000",
        "description": "",
        "status_code": "",
        "status_text": "",
        "email": "",
        "phone": "",
        "customer_uuid": "68d9feaa-04a9-4c48-8c00-a0b79c8b2f70",
        "multi_use_token": "",
        "pending": true,
        "billing_address": {
             "first_name": "",
             "last_name": "",
             "addr1": "",
             "addr2": "",
             "city": "",
             "state": "",
             "zip": ""
      },
      {
          "transaction_type": "CC",
        "transaction_status": "CC Pending",
        "transaction_status_description": "A transaction that has not cleared yet",
        "transaction_number": "",
        "amount": "25.0000",
        "description": "",
        "status_code": "",
        "status_text": "",
        "email": "",
        "phone": "",
        "customer_uuid": "68d9feaa-04a9-4c48-8c00-a0b79c8b2f70",
        "multi_use_token": "",
        "pending": true,
        "billing_address": {
             "first_name": "",
             "last_name": "",
             "addr1": "",
             "addr2": "",
             "city": "",
             "state": "",
             "zip": ""
        }
      }
   ]
}

Charge a Credit Card

POST

https://app.dimepayments.com

/api/transaction/charge-card

requires authentication

This endpoint allows you to charge a credit card using the PAN Data or a Token. This endpoint will process the charge and return a token representing the card that can be used for transactions as well as the transactionId and the customerUUID if requested. If you pass a customer UUID or a customer phone number, then a customer record will be created or retrieved if it already exists, also making the customer UUID available for the purpose of associating charges to a customer. You must be PCI Compliant (have an AoC on file with Dime Payments) to process PAN Data. A token can optionally be provided to process charges without requiring PCI compliance as no PAN data is being sent.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

amount

number

required

Example:

4326.41688

sid

numeric

required

ID of merchant account processing the charge.

Example:

1234567

phone

Must be the phone number in e164 format.

Example:

+177012345678

customer_uuid

string

required

Must be a valid UUID.

Example:

a4855dc5-0acb-33c3-b921-f4291f719ca0

email

email:rfc

The email of a customer. Max: 50.

Example:

[email protected]

memo

string

A string containing memo related information, such as an invoice ID. Max: 120.

Example:

architecto

token

string

An optional token to be used to reference a stored card for processing

Example:

architecto

cardholder_name

string

required

The name of the cardholder. Max: 50.

Example:

John Doe

card_number

numeric

The credit card number. Min: 15. Max: 16.

Example:

architecto

expiration_date

string

Expiration date of the card, in the form mm/YYYY.

Example:

01/2025

cvv

numeric

optional The card's CVV. Min: 3, Max: 4.

Example:

123

billing_address

object

first_name

string

required_without:data.token. Must not be greater than 50 characters.

Example:

m

last_name

string

Must not be greater than 50 characters.

Example:

i

addr1

string

The cardholder's address line 1. Max: 55.

Example:

1234 Main St

addr2

string

The cardholder's address line 2. Max: 55.

Example:

Suite 100

city

string

The cardholder's city. Max: 55.

Example:

Atlanta

state

string

The cardholder's state. Max: 2.

Example:

NY

zip

numeric

required

The cardholder's ZIP code. Digits: 5.

Example:

10001

uuid

string

The UUID of the customer record.

Example:

60dac128-28da-41ae-8632-aee299de13fd

Response Fields

data

object

amount

The amount of the transaction in USD.

customer_uuid

The unique UUID of the merchant's customer, only if a customer record was created.

transaction_type

ACH or Credit Card.

transactionNumber

The unique transaction used for referencing in the future.

description

The original memo field.

statusCode

Response code from processor.

status_text

Response text from processor.

email

The email address of a customer record, if one was created/provided.

phone

The phone number of a customer record, if one was created/provided.

multi_use_token

A token used to charge against a stored credit card.

billing_address

object

first_name

The first name field.

last_name

The last name field.

addr1

The first address line.

addr2

The second address line.

city

The city field.

state

The state field.

zip

The zip field.

Example request:

curl --request POST \
    "https://app.dimepayments.com/api/transaction/charge-card" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"amount\": 4326.41688,
        \"sid\": \"1234567\",
        \"phone\": \"+177012345678\",
        \"customer_uuid\": \"a4855dc5-0acb-33c3-b921-f4291f719ca0\",
        \"email\": \"[email protected]\",
        \"memo\": \"architecto\",
        \"token\": \"architecto\",
        \"cardholder_name\": \"John Doe\",
        \"card_number\": \"architecto\",
        \"expiration_date\": \"01\\/2025\",
        \"cvv\": \"123\",
        \"billing_address\": {
            \"first_name\": \"m\",
            \"last_name\": \"i\",
            \"addr1\": \"1234 Main St\",
            \"addr2\": \"Suite 100\",
            \"city\": \"Atlanta\",
            \"state\": \"NY\",
            \"zip\": \"10001\"
        },
        \"uuid\": \"60dac128-28da-41ae-8632-aee299de13fd\"
    }
}"

Example response:

{
    "data": {
        "amount": "1.00",
        "transaction_type": "Credit Card",
        "transactionNumber": "1234567890",
        "description": "a memo concerning this transaction",
        "status_code": "00",
        "status_text": "APPROVAL",
        "multi_use_token": "abcdefg123456790",
        "billing_address": {
            "first_name": "Jamie",
            "last_name": "Doe",
            "addr1": "1 Lakeshore Dr",
            "addr2": "Suite 100",
            "city": "Chicago",
            "state": "IL",
            "zip": "60601"
        }
    }
}

Charge a Bank Account

POST

https://app.dimepayments.com

/api/transaction/charge-ach

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

sid

numeric

required

The ID of merchant account processing the charge.

Example:

1234567

routing_number

string

required

The bank account routing number. Max: 9.

Example:

123456789

account_number

string

required

The bank account number. Max: 50.

Example:

91828382

account_type

string

required

Must be Checking or Savings.

Example:

Checking

account_name

string

required

The name on the bank account. Max: 50.

Example:

Acme Inc.

amount

number

required

The transaction amount.

Example:

99.19

phone

string

required

Example:

architecto

customer_uuid

string

optional The unique UUID of the merchant's customer.

Example:

12312312-123123123-1231231231

email

string

Must be a valid email address. Must not be greater than 50 characters.

Example:

[email protected]

memo

string

optional The memo field. Max: 120.

Example:

payment for something

billing_address

object

first_name

string

The first name. Max: 50.

Example:

Ryan

last_name

string

The first name. Max: 50.

Example:

Taylor

addr1

integer

optional The first address line. Max: 31.

Example:

123

addr2

integer

optional The second address line. Max: 31.

Example:

0

city

integer

optional The city. Max: 52.

Example:

0

state

integer

optional The state. Max: 2.

Example:

0

zip

integer

optional The zip code. Max: 5.

Example:

30009

Response Fields

data

object

transaction_type

ACH or Credit Card.

transaction_number

The unique transaction used for referencing in the future.

amount

The amount of the transaction in USD.

description

The original memo field.

status_code

Response code from processor.

status_text

Response text from processor.

email

The email address.

phone

The phone number.

customer_uuid

The customer's UUID.

multi_use_token

Not

billing_address

object

first_name

The first name field.

last_name

The last name field.

addr1

The first address line.

addr2

The second address line.

city

The city field.

state

The state field.

zip

The zip field.

Example request:

curl --request POST \
    "https://app.dimepayments.com/api/transaction/charge-ach" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": \"1234567\",
        \"routing_number\": \"123456789\",
        \"account_number\": \"91828382\",
        \"account_type\": \"Checking\",
        \"account_name\": \"Acme Inc.\",
        \"amount\": 99.19,
        \"phone\": \"architecto\",
        \"customer_uuid\": \"12312312-123123123-1231231231\",
        \"email\": \"[email protected]\",
        \"memo\": \"payment for something\",
        \"billing_address\": {
            \"first_name\": \"Ryan\",
            \"last_name\": \"Taylor\",
            \"addr1\": 123,
            \"addr2\": 0,
            \"city\": 0,
            \"state\": 0,
            \"zip\": 30009
        }
    }
}"

Example response:

{
    "data": {
        "transaction_type": "ACH",
        "transaction_number": "130",
        "amount": "25",
        "description": "",
        "status_code": "00",
        "status_text": "Success",
        "email": "[email protected]",
        "phone": "",
        "customer_uuid": "",
        "multi_use_token": "",
        "pending": false,
        "billing_address": {
            "first_name": "First",
            "last_name": "Last",
            "addr1": "12 Street Ave",
            "addr2": "Suite 123",
            "city": "Boulder",
            "state": "CO",
            "zip": "80302"
        }
    }
}

Tokenize a Credit Card

POST

https://app.dimepayments.com

/api/transaction/tokenize-card

requires authentication

This endpoint allows you to tokenize a credit card, which will verify its validity and return a token representing the card that can be used for transactions. This method requires PCI compliance on the part of the affiliate or merchant.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

sid

numeric

required

The ID of merchant account processing the charge.

Example:

1234567

cardholder_name

string

required

The name of the cardholder. Max: 50.

Example:

John Doe

card_number

numeric

required

The 15/16-digit credit card number.

Example:

1234567812345678

expiration_date

string

required

Expiry date of the card, in the form mm/YYYY.

Example:

01/2025

cvv

numeric

optional The card's CVV. Min: 3, Max: 4.

Example:

123

billing_address

object

addr1

string

required

The cardholder's address line 1. Can be empty string Max: 55.

Example:

1234 Main St

addr2

string

The cardholder's address line 2. Max: 55.

Example:

Suite 100

city

string

required

The cardholder's city.Can be empty string Max: 55.

Example:

New York

state

string

required

The cardholder's state.Can be empty string Max: 2.

Example:

NY

zip

numeric

required

The cardholder's ZIP code. Digits: 5.

Example:

10001

Example request:

curl --request POST \
    "https://app.dimepayments.com/api/transaction/tokenize-card" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": \"1234567\",
        \"cardholder_name\": \"John Doe\",
        \"card_number\": \"1234567812345678\",
        \"expiration_date\": \"01\\/2025\",
        \"cvv\": \"123\",
        \"billing_address\": {
            \"addr1\": \"1234 Main St\",
            \"addr2\": \"Suite 100\",
            \"city\": \"New York\",
            \"state\": \"NY\",
            \"zip\": \"10001\"
        }
    }
}"

Example response:

{
    "data": {
        "token": "abcd1234"
    }
}

Show Transaction

GET

https://app.dimepayments.com

/api/transaction

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

sid

numeric

required

The ID of the merchant that processed the transaction.

Example:

1234567

transaction_info_id

numeric

sometimes The transaction info id which is unique only against the SID of the merchant, and ties across all other reporting objects such as transactions.

Example:

6789131231

transaction_type

string

required

Must be either "CC" or "ACH".

Example:

ACH

transaction_id

number

This field is required when data.transaction_info_id is not present.

Example:

4326.41688

att_number

numeric

sometimes The ID of an ACH transaction.

Example:

architecto

gateway_transaction_id

numeric

sometimes The ID of a Credit Card transaction.

Example:

architecto

Response Fields

data

object

transaction_type

Transaction type. Example: Checking

transaction_status

Transaction Status. Example: CC Pending

transaction_status_description

Transaction Status Description explaining the status. Example: A credit card transaction that has not settled yet.

transaction_date

Transaction Date. Example: 2024-01-17T12:44:28.000000Z

fund_date

Fund Date. Example: 2024-01-18T21:05:21.000000Z

settle_date

Settle Date. Example: 2024-01-17T18:35:00.000000Z

amount

Transaction amount. Example: $120.00

customer_uuid

The unique UUID of the merchant's customer.

description

Transaction type. Example: Checking

billing_address

object

first_name

The first name field.

last_name

The last name field.

addr1

The first address line.

addr2

The second address line.

city

The city field.

state

The state field.

zip

The zip field.

Example request:

curl --request GET \
    --get "https://app.dimepayments.com/api/transaction" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": \"1234567\",
        \"transaction_info_id\": \"6789131231\",
        \"transaction_type\": \"ACH\",
        \"transaction_id\": 4326.41688,
        \"att_number\": \"architecto\",
        \"gateway_transaction_id\": \"architecto\"
    }
}"

Example response:

{
    "data": {
        "transaction_type": "CC",
        "transaction_status": "CC Pending",
        "transaction_status_description": "A cc transaction that is pending",
        "transaction_number": "1231",
        "amount": "25.0000",
        "description": "",
        "status_code": "",
        "status_text": "",
        "email": "",
        "phone": "",
        "customer_uuid": "68d9feaa-04a9-4c48-8c00-a0b79c8b2f70",
        "multi_use_token": "",
        "pending": true,
        "billing_address": {
            "first_name": "",
            "last_name": "",
            "addr1": "",
            "addr2": "",
            "city": "",
            "state": "",
            "zip": ""
        }
    }
}

Refund Transaction

POST

https://app.dimepayments.com

/api/transaction/refund

requires authentication

Processes a refund for a transaction based on the provided data.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

sid

numeric

required

The ID of merchant that processed the transaction.

Example:

1234567

amount

numeric

required

The amount to be refunded. Must be greater than 0 and less than the total amount of transaction.

Example:

100.50

transaction_info_id

numeric

required

The transaction info id which is unique only against the SID of the merchant, and ties across all other reporting objects such as transactions.

Example:

6789131231

transaction_type

string

required

Only required if not passing transaction_info_id. The transaction type which should be either CC or ACH.

Example:

CC

transaction_id

numeric

required

Only required if not passing transaction_info_id. The transaction_id which is returned when processing a card or ach account.

Example:

6789131231

Example request:

curl --request POST \
    "https://app.dimepayments.com/api/transaction/refund" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": \"1234567\",
        \"amount\": \"100.50\",
        \"transaction_info_id\": \"6789131231\",
        \"transaction_type\": \"CC\",
        \"transaction_id\": \"6789131231\"
    }
}"

Example response:

{"data": { "message" : "refund"}

Void Transaction

PATCH

https://app.dimepayments.com

/api/transaction/void

requires authentication

Void a transaction

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

required

Example request:

curl --request PATCH \
    "https://app.dimepayments.com/api/transaction/void" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": \"91828382\",
        \"transaction_type\": \"ACH\",
        \"transaction_id\": \"123\"
    }
}"

Example response:

{"data": "message" : "Transaction voided successfully"}}

List Customers

GET

https://app.dimepayments.com

/api/customer/list

requires authentication

Retrieves a list of customers for a given company, filtered by various parameters.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

filters

object

start_date

date

required_with:filters.end_date The start date for filtering customers in Y-m-d H:i:s format. Must be before or equal to filters.end_date.

Example:

2024-01-01 00:00:00

end_date

date

required_with:filters.start_date The end date for filtering customers in Y-m-d H:i:s format. Must be after or equal to filters.start_date.

Example:

2024-12-31 23:59:59

phone

string

A phone number to filter customers by. Must be in the US format e164.

Example:

+15555555555

email

string

An email address to filter customers by. Must comply with RFC email format.

Example:

[email protected]

Response Fields

data

object

id

Unique field that is not used anywhere else. Can be ignored.

uuid

The UUID of the customer.

first_name

The first name of the customer.

last_name

The last name of the customer.

company_name

Merchant name of customer

phone

Unique phone number of customer

email

Email address of customer

addr1

Address line 1 of customer

addr2

Address line 2 of customer

addr3

Address line 3 of customer

city

Customer's

zip

Customer's

state

Customer's

country

Customer's

last_login_at

Date string showing when this customer logged into Dime Payments last

last_login_ip

The IP address the customer last logged into Dime Payments from

Example request:

curl --request GET \
    --get "https://app.dimepayments.com/api/customer/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": 12345
    },
    \"filters\": {
        \"start_date\": \"2024-01-01 00:00:00\",
        \"end_date\": \"2024-12-31 23:59:59\",
        \"phone\": \"+15555555555\",
        \"email\": \"[email protected]\"
    }
}"

Example response:

{
    "data": [
        {
            "id": 1,
            "uuid": "60dac128-28da-41ae-8632-aee299de13fd",
            "first_name": "John",
            "last_name": "Doe",
            "company_name": "Acme Inc.",
            "phone": "+17707892222",
            "email": "[email protected]",
            "addr1": "",
            "addr2": "",
            "addr3": "",
            "city": "",
            "state": "",
            "zip": "",
            "country": "USA",
            "last_login_at": "2024-08-30T13:08:19.000000Z",
            "last_login_ip": "127.0.0.1"
        },
        {
            "id": 2,
            "uuid": "60dac128-28da-41ae-8632-aee299de13fd",
            "first_name": "Jane",
            "last_name": "Doe",
            "company_name": "",
            "phone": "+17707893333",
            "email": "[email protected]",
            "addr1": "",
            "addr2": "",
            "addr3": "",
            "city": "",
            "state": "",
            "zip": "",
            "country": "USA",
            "last_login_at": "2024-08-30T13:08:19.000000Z",
            "last_login_ip": "127.0.0.1"
        }
    ],
    "links": {
        "prev": null,
        "next": null
    },
    "meta": {
        "path": "http://relictum.test/api/customers",
        "per_page": 500,
        "next_cursor": null,
        "prev_cursor": null
    }
}

Show Customer

GET

https://app.dimepayments.com

/api/customer/show

requires authentication

Show a specific customer's details

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

filters

object

Response Fields

data

object

uuid

Unique User ID of customer

first_name

First name of customer

last_name

Last name of customer

phone

Unique phone number of customer

email

Email address of customer

addr1

Address line 1 of customer

addr2

Address line 2 of customer

addr3

Address line 3 of customer

city

Customer's

zip

Customer's

state

Customer's

country

Customer's

Example request:

curl --request GET \
    --get "https://app.dimepayments.com/api/customer/show" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": 12345
    },
    \"filters\": {
        \"phone\": \"+15555555555\",
        \"email\": \"[email protected]\",
        \"uuid\": \"60dac128-28da-41ae-8632-aee299de13fd\"
    }
}"

Example response:

{
    "data": {
        "uuid": "66f1c230-68cf-4d58-b47c-1bcb83adfddd",
        "first_name": "Ryan",
        "last_name": "Taylor",
        "phone": "+17707892072",
        "email": "[email protected]",
        "addr1": "",
        "addr2": "",
        "addr3": null,
        "city": "",
        "state": "",
        "zip": "",
        "country": "USA"
    }
}

Create Customer

POST

https://app.dimepayments.com

/api/customer/create

requires authentication

Create a customer record linked to your Company/Merchant.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

required

sid

integer

required

The SID of the Merchant.

Example:

12345

first_name

string

required

Customer's first name

Example:

architecto

last_name

string

required

Customer's last name

Example:

architecto

company_name

string

optional Name of Merchant that customer interacts with

Example:

architecto

phone

required

Customer's unique phone number

Example:

architecto

email

required

Customer's unique email

Example:

[email protected]

addr1

optional

Customer's address line 1

Example:

architecto

addr2

optional

Customer's address line 2

Example:

architecto

addr3

optional

Customer's address line 3

Example:

architecto

city

optional

Customer's city

Example:

architecto

state

optional

Customer's state

Example:

architecto

zip

optional

Customer's zip code

Example:

architecto

country

string

Must not be greater than 3 characters.

Example:

n

Response Fields

data

object

uuid

The uuid of the customer.

first_name

required The first name of the customer.

last_name

required The last name of the customer.

company_name

The Merchant name the customer interacts with.

phone

required The phone number of the customer.

email

required Customer's email.

addr1

Customer's address line 1

addr2

Customer's address line 2

addr3

Customer's address line 3

city

Customer's

state

Customer's

zip

Customer's

country

Customer's

Example request:

curl --request POST \
    "https://app.dimepayments.com/api/customer/create" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": 12345,
        \"first_name\": \"architecto\",
        \"last_name\": \"architecto\",
        \"company_name\": \"architecto\",
        \"phone\": \"architecto\",
        \"email\": \"[email protected]\",
        \"addr1\": \"architecto\",
        \"addr2\": \"architecto\",
        \"addr3\": \"architecto\",
        \"city\": \"architecto\",
        \"state\": \"architecto\",
        \"zip\": \"architecto\",
        \"country\": \"n\"
    }
}"

Example response:

{
    "data": {
        "uuid": "66f1c230-68cf-4d58-b47c-1bcb83adfddd",
        "first_name": "Ryan",
        "last_name": "Taylor",
        "phone": "+17707892072",
        "email": "[email protected]",
        "addr1": "",
        "addr2": "",
        "addr3": null,
        "city": "",
        "state": "",
        "zip": "",
        "country": "USA"
    }
}

Update Customer

PATCH

https://app.dimepayments.com

/api/customer/update

requires authentication

Update a customer record. Make changes to the customer referenced by UUID, phone number, or email. One of the filters is required to be provided to select a unique customer. Only pass the fields that require updating in the data object.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

filters

object

required

One of the filters is required to select a unique customer

data

object

required

sid

integer

required

The SID of the Merchant.

Example:

12345

first_name

optional

Customer's first name

Example:

architecto

last_name

optional

Customer's last name

Example:

architecto

company_name

optional

Name of Merchant that customer interacts with

Example:

architecto

phone

optional

Customer's unique phone number

Example:

architecto

email

optional

Customer's unique email

Example:

[email protected]

addr1

optional

Customer's address line 1

Example:

architecto

addr2

optional

Customer's address line 2

Example:

architecto

addr3

optional

Customer's address line 3

Example:

architecto

city

optional

Customer's city

Example:

architecto

state

optional

Customer's state

Example:

architecto

zip

optional

Customer's zip code

Example:

architecto

country

string

Must not be greater than 3 characters.

Example:

n

Response Fields

data

object

uuid

The UUID of the customer.

first_name

The first name of the customer.

last_name

The last name of the customer.

company_name

Merchant name of customer

phone

Unique phone number of customer

email

Email address of customer

addr1

Address line 1 of customer

addr2

Address line 2 of customer

addr3

Address line 3 of customer

city

Customer's

zip

Customer's

state

Customer's

country

Customer's

Example request:

curl --request PATCH \
    "https://app.dimepayments.com/api/customer/update" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filters\": {
        \"phone\": \"+15555555555\",
        \"uuid\": \"60dac128-28da-41ae-8632-aee299de13fd\",
        \"email\": \"[email protected]\"
    },
    \"data\": {
        \"sid\": 12345,
        \"first_name\": \"architecto\",
        \"last_name\": \"architecto\",
        \"company_name\": \"architecto\",
        \"phone\": \"architecto\",
        \"email\": \"[email protected]\",
        \"addr1\": \"architecto\",
        \"addr2\": \"architecto\",
        \"addr3\": \"architecto\",
        \"city\": \"architecto\",
        \"state\": \"architecto\",
        \"zip\": \"architecto\",
        \"country\": \"n\"
    }
}"

Example response:

{
    "data": {
        "uuid": "66f1c230-68cf-4d58-b47c-1bcb83adfddd",
        "first_name": "Ryan",
        "last_name": "Taylor",
        "phone": "+17707892072",
        "email": "[email protected]",
        "addr1": "",
        "addr2": "",
        "addr3": null,
        "city": "",
        "state": "",
        "zip": "",
        "country": "USA"
    }
}

Delete Customer

POST

https://app.dimepayments.com

/api/customer/delete

requires authentication

Delete a customer record from the selected Merchant. One of the filters is required to select a unique customer

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

filters

object

data

object

required

sid

integer

required

The SID of the merchant.

Example:

12345

first_name

optional

Customer's first name

Example:

architecto

last_name

optional

Customer's last name

Example:

architecto

company_name

optional

Name of Merchant that customer belongs to

Example:

architecto

phone

optional

Customer's unique phone number

Example:

architecto

email

optional

Customer's unique email

Example:

[email protected]

addr1

optional

Customer's address line 1

Example:

architecto

addr2

optional

Customer's address line 2

Example:

architecto

addr3

optional

Customer's address line 3

Example:

architecto

city

optional

Customer's city

Example:

architecto

state

optional

Customer's state

Example:

architecto

zip

optional

Customer's zip code

Example:

architecto

Example request:

curl --request POST \
    "https://app.dimepayments.com/api/customer/delete" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filters\": {
        \"phone\": \"+15555555555\",
        \"uuid\": \"60dac128-28da-41ae-8632-aee299de13fd\",
        \"email\": \"[email protected]\"
    },
    \"data\": {
        \"sid\": 12345,
        \"first_name\": \"architecto\",
        \"last_name\": \"architecto\",
        \"company_name\": \"architecto\",
        \"phone\": \"architecto\",
        \"email\": \"[email protected]\",
        \"addr1\": \"architecto\",
        \"addr2\": \"architecto\",
        \"addr3\": \"architecto\",
        \"city\": \"architecto\",
        \"state\": \"architecto\",
        \"zip\": \"architecto\"
    }
}"

Example response:

{
    "data": {
        "uuid": "66f1c230-68cf-4d58-b47c-1bcb83adfddd",
        "first_name": "Ryan",
        "last_name": "Taylor",
        "phone": "+17707892072",
        "email": "[email protected]",
        "addr1": "",
        "addr2": "",
        "addr3": null,
        "city": "",
        "state": "",
        "zip": "",
        "country": "USA"
    }
}

List Deposits

GET

https://app.dimepayments.com

/api/deposit/list

requires authentication

Get Deposits from Merchant Account with supporting transactions

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

filters

object

Response Fields

data

object

transaction_date

The datetime stamp of when the transaction was initiated.

fund_date

The datetime stamp of when the funds for the deposit were made available to the merchant.

transaction_info_id

The transaction info ID which is unique only against the SID for the merchant and ties across all reporting objects.

transaction_id

The transaction ID, unique only to the SID for the merchant.

transaction_detail_account

The masked first two digits of the routing number and last four digits of the bank account where funds were deposited.

authorization_amount

The amount the transaction was authorized for.

net_amount

The amount the merchant will receive from the transaction after transaction fees.

sweep_id

The ID of the sweep the deposit was associated with, which is associated with single transactions and can be used for referencing transactions included in a deposit.

Example request:

curl --request GET \
    --get "https://app.dimepayments.com/api/deposit/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": \"91828382\"
    },
    \"filters\": {
        \"start_date\": \"\\\"2024-04-01 00:00:00\\\"\",
        \"end_date\": \"\\\"2024-04-01 23:59:59\\\"\"
    }
}"

Example response:

{
    "data": [
        {
            "transaction_date": "2023-02-17 02:41:04",
            "fund_date": "2023-02-17 02:41:04",
            "transaction_info_id": "789846193",
            "transaction_id": "3",
            "transaction_detail_account": "0089..9845",
            "authorization_amount": "0.7100",
            "net_amount": "0.7200",
            "sweep_id": "125068038"
        }
    ]
}

List Deposits with Supporting Trans

GET

https://app.dimepayments.com

/api/deposit/list-with-trans

requires authentication

Get Deposits from Merchant Account with supporting transactions. Could result in large datasets if range is too large.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

required

filters

object

Response Fields

data

object

sid

Merchant's sid that was requested.

count

Number of deposits that have left the escrow account on the way to a merchant account.

deposits

string[]

containing any deposits matched in the date range.

sweep_id

object

sid

Merchant's sid for the deposit.

transaction_info_id

The master id of the deposit for use in other parts of API.

transaction_id

The id of the deposit which will be one of the two above depending on type.

transaction_date

The date of the deposit.

fund_date

The date of the deposit.

countOfTransactions

The number of supporting transactions for the deposit.

transTotal

The total of the deposit sent to the bank.

transactions

string[]

containing supporting transactions for the deposit.

transaction_type

The type of transaction. Request a listing from developer support if unaware of options.

transaction_status

The status of the transaction. Request a listing from developer support if unaware of options.

transaction_status_description

The description of the transaction status. Request a listing from developer support if unaware of options.

transaction_number

The transaction number.

transaction_date

The date of the transaction.

fund_date

The date of the transaction.

settle_date

The date of the transaction.

amount

The gross amount of the transaction.

description

The description of the transaction.

status_code

The status code of the transaction.

status_text

The status text of the transaction.

email

The email of the transaction.

phone

The phone of the transaction.

customer_uuid

The customer uuid of the transaction.

multi_use_token

The multi use token of the transaction.

pending

The pending status of the transaction.

billing_address

object

first_name

The first name of the billing address.

last_name

The last name of the billing address.

addr1

The address line 1 of the billing address.

addr2

The address line 2 of the billing address.

city

The city of the billing address.

state

The state of the billing address.

zip

The zip of the billing address.

Example request:

curl --request GET \
    --get "https://app.dimepayments.com/api/deposit/list-with-trans" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": \"91828382\",
        \"start_date\": \"\\\"2024-04-01 00:00:00\\\"\",
        \"end_date\": \"\\\"2024-04-01 23:59:59\\\"\"
    },
    \"filters\": {
        \"start_date\": \"2025-06-26 10:28:15\",
        \"end_date\": \"2025-06-26 10:28:15\"
    }
}"

Example response:

{
  "data": {
      "sid": "XXXXX",
      "count": 1,
      "deposits": {
          "128298672": {
             "sid": "XXXXX",
             "transaction_info_id": "983999999",
             "transaction_id": "382",
             "transaction_date": "2024-05-01T04:00:00.000000Z",
             "fund_date": "2024-05-01 02:20:35",
             "countOfTransactions": 3,
             "transTotal": "545.98",
             "transactions": [
             {
                 "transaction_type": "ACH",
                 "transaction_status": "ACH_PAYMENT_CREDIT",
                 "transaction_status_description": "Successfully completed ACH Payment that has been posted to the Escrow Account.",
                 "transaction_number": "369",
                 "transaction_date": "2024-04-29T08:30:25.000000Z",
                 "fund_date": "2024-04-30T20:05:21.000000Z",
                 "settle_date": "2024-04-29T17:51:02.000000Z",
                 "amount": "369.0000",
                 "description": "",
                 "status_code": "",
                 "status_text": "",
                 "email": "",
                 "phone": "",
                 "customer_uuid": "",
                 "multi_use_token": "",
                 "pending": false,
                 "billing_address": {
                 "first_name": null,
                 "last_name": null,
                 "addr1": null,
                 "addr2": null,
                 "city": null,
                 "state": null,
                 "zip": null
             }
             },
             {
                 "transaction_type": "CC",
                 "transaction_status": "CC_CREDIT",
                 "transaction_status_description": "Successful credit/debit card transaction that brings funds into the ProPay Account.",
                 "transaction_number": "1919162951",
                 "transaction_date": "2024-04-29T08:37:29.000000Z",
                 "fund_date": "2024-04-30T20:05:22.000000Z",
                 "settle_date": "2024-05-07T11:30:03.000000Z",
                 "amount": "103.0800",
                 "description": "",
                 "status_code": "",
                 "status_text": "",
                 "email": "",
                 "phone": "",
                 "customer_uuid": "",
                 "multi_use_token": "",
                 "pending": false,
                 "billing_address": {
                 "first_name": null,
                 "last_name": null,
                 "addr1": null,
                 "addr2": null,
                 "city": null,
                 "state": null,
                 "zip": null
             }
             },
             {
                 "transaction_type": "CC",
                 "transaction_status": "CC_CREDIT",
                 "transaction_status_description": "Successful credit/debit card transaction that brings funds into the ProPay Account.",
                 "transaction_number": "1920383851",
                 "transaction_date": "2024-04-29T11:52:43.000000Z",
                 "fund_date": "2024-04-30T20:05:22.000000Z",
                 "settle_date": "2024-05-07T11:30:03.000000Z",
                 "amount": "82.5200",
                 "description": "",
                 "status_code": "",
                 "status_text": "",
                 "email": "",
                 "phone": "",
                 "customer_uuid": "",
                 "multi_use_token": "",
                 "pending": false,
                 "billing_address": {
                 "first_name": null,
                 "last_name": null,
                 "addr1": null,
                 "addr2": null,
                 "city": null,
                 "state": null,
                 "zip": null
             }
             }
             ]
         ]
     }
}

Show Deposit with Supporting Trans

GET

https://app.dimepayments.com

/api/deposit/show

requires authentication

Show a Deposit from Merchant Account with supporting transactions

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

required

Response Fields

data

object

sid

Merchant's sid that was requested.

transaction_info_id

The transaction_info_id of the deposit.

transaction_id

The transaction_id of the deposit.

transaction_date

The date of the deposit.

fund_date

The date of the deposit.

countOfTransactions

The number of transactions in the deposit.

transTotal

The total amount sent to the bank.

transactions

string[]

containing any transactions supporting the deposit.

transaction_type

The type of transaction. Request a listing from developer support if unaware of options.

transaction_status

The status of the transaction. Request a listing from developer support if unaware of options.

transaction_status_description

The description of the transaction status..

transaction_number

The transaction number.

transaction_date

The date of the transaction.

fund_date

The date of the transaction.

settle_date

The date of the transaction.

amount

The gross amount of the transaction.

description

The description of the transaction.

status_code

The status code of the transaction.

status_text

The status text of the transaction.

email

The email of the transaction.

phone

The phone of the transaction.

customer_uuid

The customer uuid of the transaction.

multi_use_token

The multi use token of the transaction.

pending

The pending status of the transaction.

billing_address

object

first_name

The first name of the billing address.

last_name

The last name of the billing address.

addr1

The address 1 of the billing address.

addr2

The address 2 of the billing address.

city

The city of the billing address.

state

The state of the billing address.

zip

The zip of the billing address.

Example request:

curl --request GET \
    --get "https://app.dimepayments.com/api/deposit/show" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": 4326.41688,
        \"transaction_info_id\": \"91828382\",
        \"sweep_id\": \"\\\"2024-04-01 00:00:00\\\"\"
    }
}"

Example response:

{
    "data": {
        "sid": "XXXXX",
        "transaction_info_id": "983999999",
        "transaction_id": "382",
        "transaction_date": "2024-05-01T04:00:00.000000Z",
        "fund_date": "2024-05-01 02:20:35",
        "countOfTransactions": 3,
        "transTotal": "545.98",
        "transactions": [
            {
                "transaction_type": "ACH",
                "transaction_status": "ACH_PAYMENT_CREDIT",
                "transaction_status_description": "Successfully completed ACH Payment that has been posted to the Escrow Account.",
                "transaction_number": "369",
                "transaction_date": "2024-04-29T08:30:25.000000Z",
                "fund_date": "2024-04-30T20:05:21.000000Z",
                "settle_date": "2024-04-29T17:51:02.000000Z",
                "amount": "369.0000",
                "description": "",
                "status_code": "",
                "status_text": "",
                "email": "",
                "phone": "",
                "customer_uuid": "",
                "multi_use_token": "",
                "pending": false,
                "billing_address": {
                    "first_name": null,
                    "last_name": null,
                    "addr1": null,
                    "addr2": null,
                    "city": null,
                    "state": null,
                    "zip": null
                }
            },
            {
                "transaction_type": "CC",
                "transaction_status": "CC_CREDIT",
                "transaction_status_description": "Successful credit/debit card transaction that brings funds into the ProPay Account.",
                "transaction_number": "1919162951",
                "transaction_date": "2024-04-29T08:37:29.000000Z",
                "fund_date": "2024-04-30T20:05:22.000000Z",
                "settle_date": "2024-05-07T11:30:03.000000Z",
                "amount": "103.0800",
                "description": "",
                "status_code": "",
                "status_text": "",
                "email": "",
                "phone": "",
                "customer_uuid": "",
                "multi_use_token": "",
                "pending": false,
                "billing_address": {
                    "first_name": null,
                    "last_name": null,
                    "addr1": null,
                    "addr2": null,
                    "city": null,
                    "state": null,
                    "zip": null
                }
            },
            {
                "transaction_type": "CC",
                "transaction_status": "CC_CREDIT",
                "transaction_status_description": "Successful credit/debit card transaction that brings funds into the ProPay Account.",
                "transaction_number": "1920383851",
                "transaction_date": "2024-04-29T11:52:43.000000Z",
                "fund_date": "2024-04-30T20:05:22.000000Z",
                "settle_date": "2024-05-07T11:30:03.000000Z",
                "amount": "82.5200",
                "description": "",
                "status_code": "",
                "status_text": "",
                "email": "",
                "phone": "",
                "customer_uuid": "",
                "multi_use_token": "",
                "pending": false,
                "billing_address": {
                    "first_name": null,
                    "last_name": null,
                    "addr1": null,
                    "addr2": null,
                    "city": null,
                    "state": null,
                    "zip": null
                }
            }
        ]
    }
}

Create Payment Method for a customer

POST

https://app.dimepayments.com

/api/payment-method/create

requires authentication

This endpoint lets you create a new payment method for a customer. Must pass at least one filter to select a specific customer

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

filters

object

data

object

sid

integer

required

The SID of the Merchant.

Example:

12345

type

string

required

Type of payment method 'cc' for credit card or 'ach' for bank accounts.

Example:

cc

token

string

required

MultiUse Token for credit card type. Required IF type is 'cc' Max: 255.

Example:

xxxxxxxx

cc_name_on_card

string

required

The name on the card. Required IF type is 'cc' Max: 255.

Example:

John Doe

cc_last_four

string

required

The last 4 digits of card number. Required IF type is 'cc' Max: 255.

Example:

7890

cc_expiration_date

string

required

The expiration date of card. Required IF type is 'cc' Max: 7.

Example:

01/2025

cc_brand

string

required

The brand of the card. Must be Visa, MasterCard, or Amex. Required IF type is 'cc' Max: 10.

Example:

Visa

ach_bank_account_name

string

required

The name on the bank account. Required IF type is 'ach' Max: 50.

Example:

Acme Inc.

ach_routing_number

string

required

Routing number for ach type. Required IF type is 'ach' Digits: 9.

Example:

123456789

ach_account_number

string

required

Account number for ach type. Required IF type is 'ach' Max: 35.

Example:

123456789

ach_ownership_type

string

required

Ownership type of the account. Must be Personal or Business. Required IF type is 'ach' Max: 35.

Example:

Personal

ach_account_type

string

required

Type of the account. Must be Checking or Savings. Required IF type is 'ach' Max: 35.

Example:

Checking

ach_bank_name

string

required

The name of the bank. Required IF type is 'ach' Max: 50.

Example:

Wells Fargo

default

boolean

Should this be default payment method.

Example:

1

addr1

string

Address Line One. Max: 75.

Example:

123 First St.

addr2

string

Address Line Two. Max: 50.

Example:

Suite 111

city

string

City name. Max: 75.

Example:

Alpharetta

state

string

Two character State. Max: 2.

Example:

GA

zip

string

Zip code. Digits: 5.

Example:

30009

Example request:

curl --request POST \
    "https://app.dimepayments.com/api/payment-method/create" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filters\": {
        \"phone\": \"+15551237890\",
        \"uuid\": \"3c37db03-dc71-4e8b-90e7-6668290b7c3d\",
        \"email\": \"[email protected]\"
    },
    \"data\": {
        \"sid\": 12345,
        \"type\": \"cc\",
        \"token\": \"xxxxxxxx\",
        \"cc_name_on_card\": \"John Doe\",
        \"cc_last_four\": \"7890\",
        \"cc_expiration_date\": \"01\\/2025\",
        \"cc_brand\": \"Visa\",
        \"ach_bank_account_name\": \"Acme Inc.\",
        \"ach_routing_number\": \"123456789\",
        \"ach_account_number\": \"123456789\",
        \"ach_ownership_type\": \"Personal\",
        \"ach_account_type\": \"Checking\",
        \"ach_bank_name\": \"Wells Fargo\",
        \"default\": true,
        \"addr1\": \"123 First St.\",
        \"addr2\": \"Suite 111\",
        \"city\": \"Alpharetta\",
        \"state\": \"GA\",
        \"zip\": \"30009\"
    }
}"

Example response:

{
  "data": {
      "id": 1,
      "type": "cc",
      "token": "xxxxxxxx",
      "first_name": "John",
      "last_name": "Doe",
      "cc_name_on_card": "Johnny Doe",
      "cc_last_four": "1234",
      "cc_expiration_date": "01/2027",
      "cc_brand": "Visa",
      "status": "New",
      "status_date": "2024-12-08 05:00:04",
      "enabled": 1,
      "default": 1,
      "addr1": "123 My Street",
      "addr2": "Suite 123",
      "addr3": "",
      "city": "Alpharetta",
      "state": "GA",
      "zip": "30009",
  }
}

List Recurring Payments

GET

https://app.dimepayments.com

/api/recurring-payment/list

requires authentication

Retrieves a list of recurring payments for a given Merchant, filtered by various parameters.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

filters

object

Response Fields

data

object

id

The id assigned. Example: 453.

name

The name assigned. Example: Acme Corp.

amount

The amount. Example: 11.11

start_date

The start date. Example: 2025-04-04T04:00:00.000000Z

end_date

The end date. Example: 2024-01-17T12:44:28.000000Z

recurrence_schedule

The schedule set. Example: Monthly, Daily, Weekly, Yearly

last_run_date

The last date the payment was attempted. Example: 2024-01-17T18:35:00.000000Z

last_run_status

The status of the last attempt. Example: Success

last_run_failed_count

The number of times this has failed. Example: 0

next_run_date

The next date the attempt will be made. Example: 2024-01-17T18:35:00.000000Z

status

The overall status of the recurring payment. Example: Active

paused_until_date

The date that payment is paused until. Example: 2024-01-17T18:35:00.000000Z

customer_uuid

The UUID of the customer if applicable. Example: 123123-123132-1231231-1231231

cancelled_at

The date this recurring payment was cancelled. Example: 2024-01-17T18:35:00.000000Z

error

The error of a failed attempt if known. Example: EXPIRED CARD

payment_method

object

id

The id of the assigned payment method. Example: 69

type

The type of the assigned payment method. Example: cc OR ach

last_four

The last four digits of the assigned payment method. Example: 1234

expiration

The expiration of the assigned payment method. Example: MM/YYYY

zip

The zip of the assigned payment method. Example: 30090

name_on_card

The name on the card of the assigned payment method. Example: John Doe

bank_account_name

If ACH: The bank account name. Example: Acme Corp

routing_number

If ACH: The bank routing number. Example: 123456789

account_number

If ACH: The bank account number. Example: 1231432

ownership_type

If ACH: The bank ownership type. Example: Business

account_type

If ACH: The bank account type. Example: Checking

bank_name

If ACH: The bank name. Example: Wells Fargo.

Example request:

curl --request GET \
    --get "https://app.dimepayments.com/api/recurring-payment/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": \"12345\"
    },
    \"filters\": {
        \"status\": \"Active, Failed, Paused, Canceled\",
        \"customer_uuid\": \"cust_456\"
    }
}"

Example response:

{
    "data": [
        {
            "name": "A Smith",
            "amount": "1819.1600",
            "start_date": "2025-04-04T04:00:00.000000Z",
            "end_date": null,
            "recurrence_schedule": "Monthly",
            "last_run_date": "2025-05-06T04:00:00.000000Z",
            "last_run_status": "Failed",
            "last_run_failed_count": 3,
            "next_run_date": null,
            "status": "Failed",
            "paused_until_date": null,
            "customer_uuid": "941d46d5-ad8e-4737-8dda-cec4a5116cde",
            "cancelled_at": null,
            "error": "EXPIRED CARD",
            "payment_method": {
                "id": 22,
                "type": "cc",
                "last_four": "8747",
                "expiration": "08/2029",
                "zip": "30115",
                "name_on_card": "Kody Smith"
            }
        }
    ],
    "links": {
        "prev": null,
        "next": null
    },
    "meta": {
        "path": "https://app.dimepayments.com/api/recurring-payment/list",
        "per_page": 500,
        "next_cursor": null,
        "prev_cursor": null
    }
}

Pause Recurring Payment

PATCH

https://app.dimepayments.com

/api/recurring-payment/pause

requires authentication

Pauses a scheduled recurring payment. If pause_until_date is not passed, it will be set to 2099-12-31

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

Response Fields

data

object

name

The name assigned. Example: Acme Corp.

amount

The amount. Example: 11.11

start_date

The start date. Example: 2025-04-04T04:00:00.000000Z

end_date

The end date. Example: 2024-01-17T12:44:28.000000Z

recurrence_schedule

The schedule set. Example: Monthly, Daily, Weekly, Yearly

last_run_date

The last date the payment was attempted. Example: 2024-01-17T18:35:00.000000Z

last_run_status

The status of the last attempt. Example: Success

last_run_failed_count

The number of times this has failed. Example: 0

next_run_date

The next date the attempt will be made. Example: 2024-01-17T18:35:00.000000Z

status

The overall status of the recurring payment. Example: Active

paused_until_date

The date that payment is paused until. Example: 2024-01-17T18:35:00.000000Z

customer_uuid

The UUID of the customer if applicable. Example: 123123-123132-1231231-1231231

cancelled_at

The date this recurring payment was cancelled. Example: 2024-01-17T18:35:00.000000Z

error

The error of a failed attempt if known. Example: EXPIRED CARD

payment_method

object

id

The id of the assigned payment method. Example: 69

type

The type of the assigned payment method. Example: cc OR ach

last_four

The last four digits of the assigned payment method. Example: 1234

expiration

The expiration of the assigned payment method. Example: MM/YYYY

zip

The zip of the assigned payment method. Example: 30090

name_on_card

The name on the card of the assigned payment method. Example: John Doe

bank_account_name

If ACH: The bank account name. Example: Acme Corp

routing_number

If ACH: The bank routing number. Example: 123456789

account_number

If ACH: The bank account number. Example: 1231432

ownership_type

If ACH: The bank ownership type. Example: Business

account_type

If ACH: The bank account type. Example: Checking

bank_name

If ACH: The bank name. Example: Wells Fargo.

Example request:

curl --request PATCH \
    "https://app.dimepayments.com/api/recurring-payment/pause" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": \"12345\",
        \"recurring_payment_id\": 12345,
        \"pause_until_date\": \"2021-01-01 00:00:00\"
    }
}"

Example response:

{
    "data": [
        {
            "name": "A Smith",
            "amount": "1819.1600",
            "start_date": "2025-04-04T04:00:00.000000Z",
            "end_date": null,
            "recurrence_schedule": "Monthly",
            "last_run_date": "2025-05-06T04:00:00.000000Z",
            "last_run_status": "Failed",
            "last_run_failed_count": 3,
            "next_run_date": null,
            "status": "Paused",
            "paused_until_date": "2027-05-06T04:00:00.000000Z",
            "customer_uuid": "941d46d5-ad8e-4737-8dda-cec4a5116cde",
            "cancelled_at": null,
            "error": "EXPIRED CARD",
            "payment_method": {
                "id": 22,
                "type": "cc",
                "last_four": "8747",
                "expiration": "08/2029",
                "zip": "30115",
                "name_on_card": "Kody Smith"
            }
        }
    ],
    "links": {
        "prev": null,
        "next": null
    },
    "meta": {
        "path": "https://app.dimepayments.com/api/recurring-payment/list",
        "per_page": 500,
        "next_cursor": null,
        "prev_cursor": null
    }
}

Cancel Recurring Payment

PATCH

https://app.dimepayments.com

/api/recurring-payment/cancel

requires authentication

Cancels a scheduled recurring payment.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

Response Fields

data

object

name

The name assigned. Example: Acme Corp.

amount

The amount. Example: 11.11

start_date

The start date. Example: 2025-04-04T04:00:00.000000Z

end_date

The end date. Example: 2024-01-17T12:44:28.000000Z

recurrence_schedule

The schedule set. Example: Monthly, Daily, Weekly, Yearly

last_run_date

The last date the payment was attempted. Example: 2024-01-17T18:35:00.000000Z

last_run_status

The status of the last attempt. Example: Success

last_run_failed_count

The number of times this has failed. Example: 0

next_run_date

The next date the attempt will be made. Example: 2024-01-17T18:35:00.000000Z

status

The overall status of the recurring payment. Example: Active

paused_until_date

The date that payment is paused until. Example: 2024-01-17T18:35:00.000000Z

customer_uuid

The UUID of the customer if applicable. Example: 123123-123132-1231231-1231231

cancelled_at

The date this recurring payment was cancelled. Example: 2024-01-17T18:35:00.000000Z

error

The error of a failed attempt if known. Example: EXPIRED CARD

payment_method

object

id

The id of the assigned payment method. Example: 69

type

The type of the assigned payment method. Example: cc OR ach

last_four

The last four digits of the assigned payment method. Example: 1234

expiration

The expiration of the assigned payment method. Example: MM/YYYY

zip

The zip of the assigned payment method. Example: 30090

name_on_card

The name on the card of the assigned payment method. Example: John Doe

bank_account_name

If ACH: The bank account name. Example: Acme Corp

routing_number

If ACH: The bank routing number. Example: 123456789

account_number

If ACH: The bank account number. Example: 1231432

ownership_type

If ACH: The bank ownership type. Example: Business

account_type

If ACH: The bank account type. Example: Checking

bank_name

If ACH: The bank name. Example: Wells Fargo.

Example request:

curl --request PATCH \
    "https://app.dimepayments.com/api/recurring-payment/cancel" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": \"12345\",
        \"recurring_payment_id\": 12345
    }
}"

Example response:

{
"data": {
"name": "A Smith",
"amount": "1819.1600",
"start_date": "2025-04-04T04:00:00.000000Z",
"end_date": null,
"recurrence_schedule": "Monthly",
"last_run_date": "2025-05-06T04:00:00.000000Z",
"last_run_status": "Failed",
"last_run_failed_count": 3,
"next_run_date": null,
"status": "Cancelled",
"paused_until_date": null,
"customer_uuid": "941d46d5-ad8e-4737-8dda-cec4a5116cde",
"cancelled_at": "2027-05-06T04:00:00.000000Z",
"error": "EXPIRED CARD",
"payment_method": {
"id": 22,
"type": "cc",
"last_four": "8747",
"expiration": "08/2029",
"zip": "30115",
"name_on_card": "Kody Smith"
}
}

Activate Recurring Payment

PATCH

https://app.dimepayments.com

/api/recurring-payment/activate

requires authentication

Activates a scheduled recurring payment. Set to status of Active and calculates next run date.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

Response Fields

data

object

name

The name assigned. Example: Acme Corp.

amount

The amount. Example: 11.11

start_date

The start date. Example: 2025-04-04T04:00:00.000000Z

end_date

The end date. Example: 2024-01-17T12:44:28.000000Z

recurrence_schedule

The schedule set. Example: Monthly, Daily, Weekly, Yearly

last_run_date

The last date the payment was attempted. Example: 2024-01-17T18:35:00.000000Z

last_run_status

The status of the last attempt. Example: Success

last_run_failed_count

The number of times this has failed. Example: 0

next_run_date

The next date the attempt will be made. Example: 2024-01-17T18:35:00.000000Z

status

The overall status of the recurring payment. Example: Active

paused_until_date

The date that payment is paused until. Example: 2024-01-17T18:35:00.000000Z

customer_uuid

The UUID of the customer if applicable. Example: 123123-123132-1231231-1231231

cancelled_at

The date this recurring payment was cancelled. Example: 2024-01-17T18:35:00.000000Z

error

The error of a failed attempt if known. Example: EXPIRED CARD

payment_method

object

id

The id of the assigned payment method. Example: 69

type

The type of the assigned payment method. Example: cc OR ach

last_four

The last four digits of the assigned payment method. Example: 1234

expiration

The expiration of the assigned payment method. Example: MM/YYYY

zip

The zip of the assigned payment method. Example: 30090

name_on_card

The name on the card of the assigned payment method. Example: John Doe

bank_account_name

If ACH: The bank account name. Example: Acme Corp

routing_number

If ACH: The bank routing number. Example: 123456789

account_number

If ACH: The bank account number. Example: 1231432

ownership_type

If ACH: The bank ownership type. Example: Business

account_type

If ACH: The bank account type. Example: Checking

bank_name

If ACH: The bank name. Example: Wells Fargo.

Example request:

curl --request PATCH \
    "https://app.dimepayments.com/api/recurring-payment/activate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": \"12345\",
        \"recurring_payment_id\": 12345
    }
}"

Example response:

{
"data": {
"name": "A Smith",
"amount": "1819.1600",
"start_date": "2025-04-04T04:00:00.000000Z",
"end_date": null,
"recurrence_schedule": "Monthly",
"last_run_date": "2025-05-06T04:00:00.000000Z",
"last_run_status": "Failed",
"last_run_failed_count": 3,
"next_run_date": "2027-06-06T04:00:00.000000Z",
"status": "Active",
"paused_until_date": null,
"customer_uuid": "941d46d5-ad8e-4737-8dda-cec4a5116cde",
"cancelled_at": null,
"error": "EXPIRED CARD",
"payment_method": {
"id": 22,
"type": "cc",
"last_four": "8747",
"expiration": "08/2029",
"zip": "30115",
"name_on_card": "Kody Smith"
}
}

Create Recurring Payment

POST

https://app.dimepayments.com

/api/recurring-payment/create

requires authentication

Creates a scheduled recurring payment. The payment will run on the next date based on schedule and start date. So if you create one that starts on 2025-01-01 00:00:00 with Monthly, then the payment method will be charged on 2025-02-01 Recurring Payments run around 0500 EST.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

sid

string

required

The ID of the merchant that processed the transactions.

Example:

12345

name

string

required

The name for the recurring payment.

Example:

Rent

amount

number

required

The amount for the recurring payment in US Dollars and Cents.

Example:

1101.69

start_date

date

required

The date the recurring payment should start in correct format.

Example:

2025-06-12 13:26:00

end_date

date

optional The date the recurring payment should end in correct format.

Example:

2026-06-12 13:26:00

recurrence_schedule

string

required

The schedule: Weekly, Biweekly, FirstFifteenth, Monthly, Yearly.

Example:

Monthly

payment_method

integer

required

The ID of the payment method.

Example:

69585

customer_uuid

string

required

The UUID of the customer.

Example:

12312312-12312321-12312312-12312312

Response Fields

data

object

name

The name assigned. Example: Acme Corp.

amount

The amount. Example: 11.11

start_date

The start date. Example: 2025-04-04T04:00:00.000000Z

end_date

The end date. Example: 2024-01-17T12:44:28.000000Z

recurrence_schedule

The schedule set. Example: Monthly, Daily, Weekly, Yearly

last_run_date

The last date the payment was attempted. Example: 2024-01-17T18:35:00.000000Z

last_run_status

The status of the last attempt. Example: Success

last_run_failed_count

The number of times this has failed. Example: 0

next_run_date

The next date the attempt will be made. Example: 2024-01-17T18:35:00.000000Z

status

The overall status of the recurring payment. Example: Active

paused_until_date

The date that payment is paused until. Example: 2024-01-17T18:35:00.000000Z

customer_uuid

The UUID of the customer if applicable. Example: 123123-123132-1231231-1231231

cancelled_at

The date this recurring payment was cancelled. Example: 2024-01-17T18:35:00.000000Z

error

The error of a failed attempt if known. Example: EXPIRED CARD

payment_method

object

id

The id of the assigned payment method. Example: 69

type

The type of the assigned payment method. Example: cc OR ach

last_four

The last four digits of the assigned payment method. Example: 1234

expiration

The expiration of the assigned payment method. Example: MM/YYYY

zip

The zip of the assigned payment method. Example: 30090

name_on_card

The name on the card of the assigned payment method. Example: John Doe

bank_account_name

If ACH: The bank account name. Example: Acme Corp

routing_number

If ACH: The bank routing number. Example: 123456789

account_number

If ACH: The bank account number. Example: 1231432

ownership_type

If ACH: The bank ownership type. Example: Business

account_type

If ACH: The bank account type. Example: Checking

bank_name

If ACH: The bank name. Example: Wells Fargo.

Example request:

curl --request POST \
    "https://app.dimepayments.com/api/recurring-payment/create" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": \"12345\",
        \"name\": \"Rent\",
        \"amount\": 1101.69,
        \"start_date\": \"2025-06-12 13:26:00\",
        \"end_date\": \"2026-06-12 13:26:00\",
        \"recurrence_schedule\": \"Monthly\",
        \"payment_method\": 69585,
        \"customer_uuid\": \"12312312-12312321-12312312-12312312\"
    }
}"

Example response:

{
"data": {
"name": "Rent",
"amount": "1819.1600",
"start_date": "2025-04-04T04:00:00.000000Z",
"end_date": null,
"recurrence_schedule": "Monthly",
"last_run_date": "",
"last_run_status": "",
"last_run_failed_count": 3,
"next_run_date": "2027-06-06T04:00:00.000000Z",
"status": "Active",
"paused_until_date": null,
"customer_uuid": "941d46d5-ad8e-4737-8dda-cec4a5116cde",
"cancelled_at": null,
"error": "",
"payment_method": {
"id": 22,
"type": "cc",
"last_four": "8247",
"expiration": "08/2030",
"zip": "30111",
"name_on_card": "John Doe"
}
}

Show Recurring Payment

GET

https://app.dimepayments.com

/api/recurring-payment/show

requires authentication

Show details of a scheduled recurring payment.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Body Parameters

data

object

Response Fields

data

object

name

The name assigned. Example: Acme Corp.

amount

The amount. Example: 11.11

start_date

The start date. Example: 2025-04-04T04:00:00.000000Z

end_date

The end date. Example: 2024-01-17T12:44:28.000000Z

recurrence_schedule

The schedule set. Example: Monthly, Daily, Weekly, Yearly

last_run_date

The last date the payment was attempted. Example: 2024-01-17T18:35:00.000000Z

last_run_status

The status of the last attempt. Example: Success

last_run_failed_count

The number of times this has failed. Example: 0

next_run_date

The next date the attempt will be made. Example: 2024-01-17T18:35:00.000000Z

status

The overall status of the recurring payment. Example: Active

paused_until_date

The date that payment is paused until. Example: 2024-01-17T18:35:00.000000Z

customer_uuid

The UUID of the customer if applicable. Example: 123123-123132-1231231-1231231

cancelled_at

The date this recurring payment was cancelled. Example: 2024-01-17T18:35:00.000000Z

error

The error of a failed attempt if known. Example: EXPIRED CARD

payment_method

object

id

The id of the assigned payment method. Example: 69

type

The type of the assigned payment method. Example: cc OR ach

last_four

The last four digits of the assigned payment method. Example: 1234

expiration

The expiration of the assigned payment method. Example: MM/YYYY

zip

The zip of the assigned payment method. Example: 30090

name_on_card

The name on the card of the assigned payment method. Example: John Doe

bank_account_name

If ACH: The bank account name. Example: Acme Corp

routing_number

If ACH: The bank routing number. Example: 123456789

account_number

If ACH: The bank account number. Example: 1231432

ownership_type

If ACH: The bank ownership type. Example: Business

account_type

If ACH: The bank account type. Example: Checking

bank_name

If ACH: The bank name. Example: Wells Fargo.

Example request:

curl --request GET \
    --get "https://app.dimepayments.com/api/recurring-payment/show" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"sid\": \"12345\",
        \"recurring_payment_id\": 12345
    }
}"

Example response:

{
"data": {
"name": "A Smith",
"amount": "1819.1600",
"start_date": "2025-04-04T04:00:00.000000Z",
"end_date": null,
"recurrence_schedule": "Monthly",
"last_run_date": "2025-05-06T04:00:00.000000Z",
"last_run_status": "Failed",
"last_run_failed_count": 3,
"next_run_date": "2027-06-06T04:00:00.000000Z",
"status": "Active",
"paused_until_date": null,
"customer_uuid": "941d46d5-ad8e-4737-8dda-cec4a5116cde",
"cancelled_at": null,
"error": "EXPIRED CARD",
"payment_method": {
"id": 22,
"type": "cc",
"last_four": "8747",
"expiration": "08/2029",
"zip": "30115",
"name_on_card": "Kody Smith"
}
}

Get New Customers

GET

https://app.dimepayments.com

/api/zapier/new-customers

requires authentication

Get a list of all new customers since the last time it was checked.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Response Fields

data

object

id

Customer's

first_name

Customer's first name

last_name

Customer's last name

phone

Customer's phone number

email

Customer's

addr1

Customer's address line 1

addr2

Customer's address line 2

addr3

Customer's address line 3

city

Customer's

state

Customer's

zip

Customer's zip code

country

Customer's

Example request:

curl --request GET \
    --get "https://app.dimepayments.com/api/zapier/new-customers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Get Transactions

GET

https://app.dimepayments.com

/api/zapier/transactions

requires authentication

Get a list of all transactions for a Merchant

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Response Fields

data

object

amount

Transaction

business

Business associated with transaction

transaction_date

Transaction

invoice_number

Transaction invoice number

first_name

Customer's first name

last_name

Customer's first name

phone

Customer's phone number

email

Customer's email address

Example request:

curl --request GET \
    --get "https://app.dimepayments.com/api/zapier/transactions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Get Transactions by Customer

GET

https://app.dimepayments.com

/api/zapier/transactions/{phone}

requires authentication

Get a list of all transactions for a given customer using their phone number

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

URL Parameters

phone

string

required

Example:

architecto

Body Parameters

start_date

string

Must be a valid date. Must be a valid date in the format Y-m-d H:i:s. Must be a date before or equal to end_date.

Example:

2021-07-19

end_date

string

Must be a valid date. Must be a valid date in the format Y-m-d H:i:s. Must be a date after or equal to start_date.

Example:

2051-07-20

last_days

number

Must not be greater than 365.

Example:

22

data

object

Response Fields

data

object

amount

Transaction

transaction_date

Transaction

invoice_number

Transaction invoice number

first_name

Customer's first name

last_name

Customer's first name

phone

Customer's phone number

email

Customer's email address

Example request:

curl --request GET \
    --get "https://app.dimepayments.com/api/zapier/transactions/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2021-07-19\",
    \"end_date\": \"2051-07-20\",
    \"last_days\": 22,
    \"data\": {
        \"start_date\": \"2020-10-15\",
        \"end_date\": \"2020-10-15\",
        \"last_days\": \"90\"
    }
}"

Example response:

Get Most Recent Transaction

GET

https://app.dimepayments.com

/api/zapier/new-transactions

requires authentication

Get the most recent transactions details

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Accept

Example:

application/json

Response Fields

data

object

amount

Transaction

transaction_date

Transaction

invoice_number

Transaction invoice number

first_name

Customer's first name

last_name

Customer's first name

phone

Customer's phone number

email

Customer's email address

Example request:

curl --request GET \
    --get "https://app.dimepayments.com/api/zapier/new-transactions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Dime Payments API Documentation

Dime Payments API Documentation

Introduction

Authenticating requests

Merchant management

List Merchants

Headers

Body Parameters

Response Fields

Show a specific Merchant's Details

Headers

Body Parameters

Response Fields

Create Merchant

Headers

Body Parameters

Response Fields

Update a specific Merchant's Details

Headers

Body Parameters

Response Fields

Get a unique, secure link to the signup application for a Merchant.

Headers

Body Parameters

Response Fields

Transaction management

List Transactions

Headers

Body Parameters

Response Fields

Charge a Credit Card

Headers

Body Parameters

Response Fields

Charge a Bank Account

Headers

Body Parameters

Response Fields

Tokenize a Credit Card

Headers

Body Parameters

Show Transaction

Headers

Body Parameters

Response Fields

Refund Transaction

Headers

Body Parameters

Void Transaction

Headers

Body Parameters

Customer management

List Customers

Headers

Body Parameters

Response Fields

Show Customer

Headers

Body Parameters

Response Fields

Create Customer

Headers

Body Parameters

Response Fields

Update Customer

Headers

Body Parameters

Response Fields

Delete Customer

Headers

Body Parameters

Deposit management

List Deposits

Headers

Body Parameters

Response Fields

List Deposits with Supporting Trans

Headers

Body Parameters

Response Fields