JobPayment

Process and track payments for jobs including credit cards, ACH, and other payment methods.

Quick Reference

Method	Endpoint	Description
GET	/api/job/{jobDisplayId}/payment/create
POST	/api/job/{jobDisplayId}/payment/ACHPaymentSession
POST	/api/job/{jobDisplayId}/payment/ACHCreditTransfer
GET	/api/job/{jobDisplayId}/payment
POST	/api/job/{jobDisplayId}/payment/attachCustomerBank
POST	/api/job/{jobDisplayId}/payment/verifyJobACHSource
POST	/api/job/{jobDisplayId}/payment/cancelJobACHVerification
GET	/api/job/{jobDisplayId}/payment/sources
POST	/api/job/{jobDisplayId}/payment/bysource
POST	/api/job/{jobDisplayId}/payment/banksource

GET /api/job/{jobDisplayId}/payment/create

Parameters:

Path Parameters:

jobDisplayId (string, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/job/{jobDisplayId}/payment/create"
,
    jobDisplayId="2000000"

)

# Process the response
print(response)

ab api raw get /api/job/{jobDisplayId}/payment/create \
    jobDisplayId=2000000

curl -X GET \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  'https://api.abconnect.co/api/job/2000000/payment/create'

Sample Response:

{
  "status": "success",
  "data": {}
}

POST /api/job/{jobDisplayId}/payment/ACHPaymentSession

Parameters:

Path Parameters:

jobDisplayId (string, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/job/{jobDisplayId}/payment/ACHPaymentSession"
,
    jobDisplayId="2000000"

)

# Process the response
print(response)

ab api raw post /api/job/{jobDisplayId}/payment/ACHPaymentSession \
    jobDisplayId=2000000

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  'https://api.abconnect.co/api/job/2000000/payment/ACHPaymentSession'

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

POST /api/job/{jobDisplayId}/payment/ACHCreditTransfer

Parameters:

Path Parameters:

jobDisplayId (string, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/job/{jobDisplayId}/payment/ACHCreditTransfer"
,
    jobDisplayId="2000000"

)

# Process the response
print(response)

ab api raw post /api/job/{jobDisplayId}/payment/ACHCreditTransfer \
    jobDisplayId=2000000

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  'https://api.abconnect.co/api/job/2000000/payment/ACHCreditTransfer'

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

GET /api/job/{jobDisplayId}/payment

Parameters:

Path Parameters:

jobDisplayId (string, path) (required): No description available

Query Parameters:

jobSubKey (string, query): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/job/{jobDisplayId}/payment"
,
    jobDisplayId="2000000"

)

# Process the response
print(response)

ab api raw get /api/job/{jobDisplayId}/payment \
    jobDisplayId=2000000

curl -X GET \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  'https://api.abconnect.co/api/job/2000000/payment'

Sample Response:

{
  "status": "success",
  "data": {}
}

POST /api/job/{jobDisplayId}/payment/attachCustomerBank

Parameters:

Path Parameters:

jobDisplayId (string, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/job/{jobDisplayId}/payment/attachCustomerBank"
,
    jobDisplayId="2000000"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

ab api raw post /api/job/{jobDisplayId}/payment/attachCustomerBank \
    jobDisplayId=2000000

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "example": "data"
  }' \
  'https://api.abconnect.co/api/job/2000000/payment/attachCustomerBank'

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

POST /api/job/{jobDisplayId}/payment/verifyJobACHSource

Parameters:

Path Parameters:

jobDisplayId (string, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/job/{jobDisplayId}/payment/verifyJobACHSource"
,
    jobDisplayId="2000000"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

ab api raw post /api/job/{jobDisplayId}/payment/verifyJobACHSource \
    jobDisplayId=2000000

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "example": "data"
  }' \
  'https://api.abconnect.co/api/job/2000000/payment/verifyJobACHSource'

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

POST /api/job/{jobDisplayId}/payment/cancelJobACHVerification

Parameters:

Path Parameters:

jobDisplayId (string, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/job/{jobDisplayId}/payment/cancelJobACHVerification"
,
    jobDisplayId="2000000"

)

# Process the response
print(response)

ab api raw post /api/job/{jobDisplayId}/payment/cancelJobACHVerification \
    jobDisplayId=2000000

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  'https://api.abconnect.co/api/job/2000000/payment/cancelJobACHVerification'

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

GET /api/job/{jobDisplayId}/payment/sources

Parameters:

Path Parameters:

jobDisplayId (string, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/job/{jobDisplayId}/payment/sources"
,
    jobDisplayId="2000000"

)

# Process the response
print(response)

ab api raw get /api/job/{jobDisplayId}/payment/sources \
    jobDisplayId=2000000

curl -X GET \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  'https://api.abconnect.co/api/job/2000000/payment/sources'

Sample Response:

1[]

POST /api/job/{jobDisplayId}/payment/bysource

Parameters:

Path Parameters:

jobDisplayId (string, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/job/{jobDisplayId}/payment/bysource"
,
    jobDisplayId="2000000"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

ab api raw post /api/job/{jobDisplayId}/payment/bysource \
    jobDisplayId=2000000

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "example": "data"
  }' \
  'https://api.abconnect.co/api/job/2000000/payment/bysource'

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

POST /api/job/{jobDisplayId}/payment/banksource

Parameters:

Path Parameters:

jobDisplayId (string, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/job/{jobDisplayId}/payment/banksource"
,
    jobDisplayId="2000000"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

ab api raw post /api/job/{jobDisplayId}/payment/banksource \
    jobDisplayId=2000000

curl -X POST \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "example": "data"
  }' \
  'https://api.abconnect.co/api/job/2000000/payment/banksource'

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}